com.helger.commons.collections.attrs

Class MapBasedGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

java.lang.Object

com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collections.attrs.MapBasedGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>, Serializable

Direct Known Subclasses:

MapBasedReadonlyAttributeContainer

@NotThreadSafe
public class MapBasedGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>
extends AbstractGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Default implementation of the IGenericReadonlyAttributeContainer based on a hash map. This implementation may carry null values but that is not recommended.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapBasedGenericReadonlyAttributeContainer(IGenericReadonlyAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aCont)
MapBasedGenericReadonlyAttributeContainer(KEYTYPE aKey, VALUETYPE aValue)
MapBasedGenericReadonlyAttributeContainer(Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

Method Summary

Methods

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()
Enumeration<KEYTYPE>	getAttributeNames() Get an enumerator over all contained attribute names.
VALUETYPE	getAttributeObject(KEYTYPE aName) Get the attribute value associated to the given attribute name.
int	hashCode()
String	toString()

Methods inherited from class com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer

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

Constructor Detail

MapBasedGenericReadonlyAttributeContainer

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

MapBasedGenericReadonlyAttributeContainer

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

MapBasedGenericReadonlyAttributeContainer

public MapBasedGenericReadonlyAttributeContainer(@Nonnull
                                         IGenericReadonlyAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aCont)

Method Detail

containsAttribute

public boolean containsAttribute(@Nullable
                        KEYTYPE aName)

Description copied from interface: IGenericReadonlyAttributeContainer

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.

getAttributeNames

@Nonnull
public Enumeration<KEYTYPE> getAttributeNames()

Description copied from interface: IGenericReadonlyAttributeContainer

Get an enumerator over all contained attribute names.

Returns:

an Enumerator over all attribute names

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: IGenericReadonlyAttributeContainer

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