com.tealium.collect.attribute

Class AttributeGroup<T extends BaseAttribute>

java.lang.Object

com.tealium.collect.attribute.AttributeGroup<T>

All Implemented Interfaces:

java.lang.Iterable<T>

public final class AttributeGroup<T extends BaseAttribute>
extends java.lang.Object
implements java.lang.Iterable<T>

An immutable group of Attributes.

This class has similar methods to collection, but does not support modification.

Since:

2015-01-22

Constructor Summary

Constructors

Constructor and Description
AttributeGroup() Creates an empty instance.
AttributeGroup(java.util.Collection<T> source) Produce an instance sourced from a collection.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(T attribute) Check to see whether this instance possesses the provided attribute by performing the Object.equals(Object) operation.
boolean	containsAll(AttributeGroup<T> other) Check to see whether this instance possesses all of the elements of the given group.
boolean	containsAllIds(AttributeGroup<T> other) Check to see whether this instance possesses all of the ids of attributes of the given group.
boolean	containsId(java.lang.String attributeId) Determine whether this instance contains an attribute matching the id provided.
boolean	containsId(T attribute) Determine whether this instance contains an attribute with an id matching given attribute.
boolean	equalIds(AttributeGroup<T> other) Determine whether this instance's elements are possessed by an alternative AttributeGroup instance, even if their values differ.
boolean	equals(java.lang.Object o) Determine whether this instance's elements are possessed by and equal an alternative AttributeGroup instance.
T	get(java.lang.String id) Retrieve the attribute that matches the given id.
int	hashCode() Produces a hashCode to represent this instance in accordance with item#9 of Effective Java 2nd Edition.
boolean	isEmpty()
java.util.Iterator<T>	iterator() Retrieve the iterator to iterate through the elements in this group.
int	size()
java.lang.Object[]	toArray() Returns a new array containing all elements contained in this AttributeGroup.
T[]	toArray(T[] contents) Returns an array containing all elements contained in this AttributeGroup.
java.lang.String	toString() Render the contents of this AttributeGroup into a string.
java.lang.String	toString(java.lang.String indentation) Render the contents of this AttributeGroup into a string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributeGroup

public AttributeGroup()

Creates an empty instance.

AttributeGroup

public AttributeGroup(java.util.Collection<T> source)

Produce an instance sourced from a collection. The constructed instance's size may not equal the Collection's size. This instance's size will only equal the count of non-null entries in the given source.

Parameters:

source - Iterable or null. When null, an empty instance will be created.

Method Detail

size

public int size()

Returns:

Number of Attribute elements this instance holds.

contains

public boolean contains(T attribute)

Check to see whether this instance possesses the provided attribute by performing the Object.equals(Object) operation.

Parameters:

attribute - an attribute this instance may hold.

Returns:

whether this container possesses the given attribute.

containsAll

public boolean containsAll(AttributeGroup<T> other)

Check to see whether this instance possesses all of the elements of the given group. The check performed is done using the Object.equals(Object) operation of each Attribute in each group.

Parameters:

other - AttributeGroup instance.

Returns:

whether this instance contains all of the attributes held by the other instance.

containsAllIds

public boolean containsAllIds(AttributeGroup<T> other)

Check to see whether this instance possesses all of the ids of attributes of the given group. The values of the attributes contained in either group may still differ.

Parameters:

other - AttributeGroup instance.

Returns:

whether this instance contains all of the attribute ids held by the other instance.

containsId

public boolean containsId(java.lang.String attributeId)

Determine whether this instance contains an attribute matching the id provided.

Parameters:

attributeId - desired id to locate

Returns:

whether this group contains the given attributeId

containsId

public boolean containsId(T attribute)

Determine whether this instance contains an attribute with an id matching given attribute.

Parameters:

attribute - desired attribute to locate

Returns:

whether this group contains the given attribute

get

public T get(java.lang.String id)

Retrieve the attribute that matches the given id.

Parameters:

id - the desired attribute's id matching BaseAttribute.getId()

Returns:

an attribute instance or null if no attribute with the given id is found.

isEmpty

public boolean isEmpty()

Returns:

Whether this group contains any attributes.

iterator

public java.util.Iterator<T> iterator()

Retrieve the iterator to iterate through the elements in this group. Iterator.remove() is not supported, and throws an UnsupportedOperationException when called. When Iterator.hasNext() returns false, calling the Iterator.next() will throw a NoSuchElementException.

Specified by:

iterator in interface java.lang.Iterable<T extends BaseAttribute>

Returns:

a new iterator instance.

equals

public boolean equals(java.lang.Object o)

Determine whether this instance's elements are possessed by and equal an alternative AttributeGroup instance.

Overrides:

equals in class java.lang.Object

Parameters:

o -

Returns:

whether this instance equals the given object.

equalIds

public boolean equalIds(AttributeGroup<T> other)

Determine whether this instance's elements are possessed by an alternative AttributeGroup instance, even if their values differ.

Parameters:

other -

Returns:

whether this instance elements have the same ids as the the given AttributeGroup.

toArray

public T[] toArray(T[] contents)

Returns an array containing all elements contained in this AttributeGroup. If the specified array is large enough to hold the elements, the specified array is used, otherwise an array of the same type is created. If the specified array is used and is larger than this AttributeGroup, the array element following the collection elements is set to null.

Parameters:

contents - the array.

Returns:

an array of the elements from this AttributeGroup.

Throws:

java.lang.ArrayStoreException - when the type of an element in this AttributeGroup cannot be stored in the type of the specified array.

toArray

public java.lang.Object[] toArray()

Returns a new array containing all elements contained in this AttributeGroup.

Returns:

an array of the elements from this AttributeGroup

toString

public java.lang.String toString(java.lang.String indentation)

Render the contents of this AttributeGroup into a string.

Parameters:

indentation - the desired indentation of the String, such as "\t" or " ". If null or an empty string is provided, returned string will be a single line.

Returns:

a human-readable description of this AttributeGroup's contents.

toString

public java.lang.String toString()

Render the contents of this AttributeGroup into a string. This method calls toString(String) with a null indentation.

Overrides:

toString in class java.lang.Object

Returns:

a single-line human-readable description of this AttributeGroup's contents.

hashCode

public int hashCode()

Produces a hashCode to represent this instance in accordance with item#9 of Effective Java 2nd Edition.

Overrides:

hashCode in class java.lang.Object

Returns:

a hashCode unique to this instance's contents.