com.phloc.commons.collections.attrs

Class MapBasedReadonlyAttributeContainer

java.lang.Object

com.phloc.commons.collections.attrs.AbstractReadonlyAttributeContainer

com.phloc.commons.collections.attrs.MapBasedReadonlyAttributeContainer

All Implemented Interfaces:

IReadonlyAttributeContainer, Serializable

@NotThreadSafe
public final class MapBasedReadonlyAttributeContainer
extends AbstractReadonlyAttributeContainer

Default implementation of the IReadonlyAttributeContainer 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
MapBasedReadonlyAttributeContainer(IReadonlyAttributeContainer aCont)
MapBasedReadonlyAttributeContainer(Map<String,?> aMap)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsAttribute(String sName) Check if an attribute of the given name is contained.
boolean	containsNoAttribute()
boolean	equals(Object o)
Set<String>	getAllAttributeNames()
Map<String,Object>	getAllAttributes()
Collection<Object>	getAllAttributeValues()
int	getAttributeCount()
Enumeration<String>	getAttributeNames() Get an enumerator over all contained attribute names.
Object	getAttributeObject(String sName) Get the attribute value associated to the given attribute name.
int	hashCode()
String	toString()

Methods inherited from class com.phloc.commons.collections.attrs.AbstractReadonlyAttributeContainer

getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, 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

MapBasedReadonlyAttributeContainer

public MapBasedReadonlyAttributeContainer(@Nonnull
                                  Map<String,?> aMap)

MapBasedReadonlyAttributeContainer

public MapBasedReadonlyAttributeContainer(@Nonnull
                                  IReadonlyAttributeContainer aCont)

Method Detail

containsAttribute

public boolean containsAttribute(@Nullable
                        String sName)

Description copied from interface: IReadonlyAttributeContainer

Check if an attribute of the given name is contained.

Parameters:

sName - name of the attribute to check

Returns:

true if the attribute is contained, false otherwise

getAllAttributes

@Nonnull
@ReturnsMutableCopy
public Map<String,Object> getAllAttributes()

Returns:

The non-null map with all contained attributes.

getAttributeNames

@Nonnull
public Enumeration<String> getAttributeNames()

Description copied from interface: IReadonlyAttributeContainer

Get an enumerator over all contained attribute names.

Returns:

an Enumerator over all attribute names

getAllAttributeNames

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

Returns:

A non-null set of all attribute names.

getAllAttributeValues

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

Returns:

A non-null collection of all attribute values.

getAttributeObject

@Nullable
public Object getAttributeObject(@Nullable
                                 String sName)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Parameters:

sName - 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