com.helger.commons.collection.attr

Class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

java.lang.Object

com.helger.commons.collection.attr.AbstractReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

IAttributeContainer<KEYTYPE,VALUETYPE>, Serializable

Direct Known Subclasses:

MapBasedAttributeContainer

@NotThreadSafe
public class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>
extends AbstractReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

Default implementation of the IAttributeContainer based on a HashMap. This implementation may carry null values but that is not recommended.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<KEYTYPE,VALUETYPE>	m_aAttrs Main attribute storage.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapBasedReadOnlyAttributeContainer(boolean bDummy, Map<KEYTYPE,VALUETYPE> aAttrMap) Constructor to use a custom map for the attribute container
	MapBasedReadOnlyAttributeContainer(IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aCont)
	MapBasedReadOnlyAttributeContainer(KEYTYPE aKey, VALUETYPE aValue)
	MapBasedReadOnlyAttributeContainer(Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

Method Summary

Modifier and Type	Method and Description
boolean	containsAttribute(KEYTYPE aName) Check if an attribute of the given name is contained.
boolean	containsNoAttribute()
boolean	equals(Object o)
Set<KEYTYPE>	getAllAttributeNames()
Map<KEYTYPE,VALUETYPE>	getAllAttributes()
Collection<VALUETYPE>	getAllAttributeValues()
int	getAttributeCount()
VALUETYPE	getAttributeObject(KEYTYPE aName) Get the attribute value associated to the given attribute name.
Iterator<Map.Entry<KEYTYPE,VALUETYPE>>	getIterator()
int	hashCode()
String	toString()

Methods inherited from class com.helger.commons.collection.attr.AbstractReadOnlyAttributeContainer

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m_aAttrs

protected final Map<KEYTYPE,VALUETYPE> m_aAttrs

Main attribute storage.

Constructor Detail

MapBasedReadOnlyAttributeContainer

public MapBasedReadOnlyAttributeContainer(@Nonnull
                                          KEYTYPE aKey,
                                          @Nullable
                                          VALUETYPE aValue)

MapBasedReadOnlyAttributeContainer

public MapBasedReadOnlyAttributeContainer(@Nonnull
                                          Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

MapBasedReadOnlyAttributeContainer

public MapBasedReadOnlyAttributeContainer(@Nonnull
                                          IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aCont)

MapBasedReadOnlyAttributeContainer

protected MapBasedReadOnlyAttributeContainer(boolean bDummy,
                                             @Nonnull
                                             Map<KEYTYPE,VALUETYPE> aAttrMap)

Constructor to use a custom map for the attribute container

Parameters:

bDummy - Dummy parameter to be used to uniquely specify the constructor

aAttrMap - The attribute map to be used.

Method Detail

getIterator

@Nonnull
public Iterator<Map.Entry<KEYTYPE,VALUETYPE>> getIterator()

Returns:

An iterator over all entries.

containsAttribute

public boolean containsAttribute(@Nullable
                                 KEYTYPE aName)

Description copied from interface: IAttributeContainer

Check if an attribute of the given name is contained.

Parameters:

aName - name of the attribute to check

Returns:

true if the attribute is contained, false otherwise

getAllAttributes

@Nonnull
 @ReturnsMutableCopy
public Map<KEYTYPE,VALUETYPE> getAllAttributes()

Returns:

The non-null map with all contained attributes.

getAllAttributeNames

@Nonnull
 @ReturnsMutableCopy
public Set<KEYTYPE> getAllAttributeNames()

Returns:

A non-null set of all attribute names.

getAllAttributeValues

@Nonnull
 @ReturnsMutableCopy
public Collection<VALUETYPE> getAllAttributeValues()

Returns:

A non-null collection of all attribute values.

getAttributeObject

@Nullable
public VALUETYPE getAttributeObject(@Nullable
                                               KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

null if no such value exists

getAttributeCount

@Nonnegative
public int getAttributeCount()

Returns:

The number of contained attributes. Always ≥ 0.

containsNoAttribute

public boolean containsNoAttribute()

Returns:

true if this attribute container does not contain any attribute at all, false if at least one attribute is contained.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object