com.helger.commons.collection.attr

Class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

java.lang.Object

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

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

IAttributeContainer<KEYTYPE,VALUETYPE>, ICommonsIterable<Map.Entry<KEYTYPE,VALUETYPE>>, Serializable, Iterable<Map.Entry<KEYTYPE,VALUETYPE>>

Direct Known Subclasses:

MapBasedAttributeContainer

@NotThreadSafe
public class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>
extends Object
implements IAttributeContainer<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 ICommonsMap<KEYTYPE,VALUETYPE>	m_aAttrs Main attribute storage.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapBasedReadOnlyAttributeContainer(boolean bDummy, ICommonsMap<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	equals(Object o)
void	forAllAttributes(BiConsumer<? super KEYTYPE,? super VALUETYPE> aConsumer) Perform an operation on all contained attributes.
void	forAllAttributeValues(Consumer<? super VALUETYPE> aConsumer) Perform an operation on all contained attribute values.
ICommonsSet<KEYTYPE>	getAllAttributeNames()
ICommonsMap<KEYTYPE,VALUETYPE>	getAllAttributes()
ICommonsCollection<VALUETYPE>	getAllAttributeValues()
int	getAttributeCount()
VALUETYPE	getAttributeObject(KEYTYPE aName) Get the attribute value associated to the given attribute name.
int	hashCode()
boolean	isEmpty()
Iterator<Map.Entry<KEYTYPE,VALUETYPE>>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute, isNotEmpty

Methods inherited from interface com.helger.commons.collection.ext.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEach, forEachBreakable, getIteratorCount, getIteratorCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

m_aAttrs

protected final ICommonsMap<KEYTYPE,VALUETYPE> m_aAttrs

Main attribute storage.

Constructor Detail

MapBasedReadOnlyAttributeContainer

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

MapBasedReadOnlyAttributeContainer

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

MapBasedReadOnlyAttributeContainer

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

MapBasedReadOnlyAttributeContainer

protected MapBasedReadOnlyAttributeContainer(boolean bDummy,
                                             @Nonnull
                                             ICommonsMap<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

iterator

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

Specified by:

iterator in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Specified by:

iterator in interface Iterable<Map.Entry<KEYTYPE,VALUETYPE>>

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.

Specified by:

containsAttribute in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - name of the attribute to check

Returns:

true if the attribute is contained, false otherwise

getAllAttributes

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

Specified by:

getAllAttributes in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

The non-null map with all contained attributes.

forAllAttributes

public void forAllAttributes(@Nonnull
                             BiConsumer<? super KEYTYPE,? super VALUETYPE> aConsumer)

Description copied from interface: IAttributeContainer

Perform an operation on all contained attributes. Use this method only for read-only operations, other you will most likely end up in a ConcurrentModificationException!

Specified by:

forAllAttributes in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aConsumer - The consumer to be invoked.

forAllAttributeValues

public void forAllAttributeValues(@Nonnull
                                  Consumer<? super VALUETYPE> aConsumer)

Description copied from interface: IAttributeContainer

Perform an operation on all contained attribute values. Use this method only for read-only operations, other you will most likely end up in a ConcurrentModificationException!

Specified by:

forAllAttributeValues in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aConsumer - The consumer to be invoked.

getAllAttributeNames

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

Specified by:

getAllAttributeNames in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

A non-null set of all attribute names.

getAllAttributeValues

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

Specified by:

getAllAttributeValues in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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.

Specified by:

getAttributeObject in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

null if no such value exists

getAttributeCount

@Nonnegative
public int getAttributeCount()

Specified by:

getAttributeCount in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

The number of contained attributes. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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