com.helger.commons.collections.attrs

Class MapBasedGenericAttributeContainerThreadSafe<KEYTYPE,VALUETYPE>

java.lang.Object

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

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

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

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

IGenericAttributeContainer<KEYTYPE,VALUETYPE>, IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>, ICloneable<MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>>, IClearable, Serializable

@ThreadSafe
public class MapBasedGenericAttributeContainerThreadSafe<KEYTYPE,VALUETYPE>
extends MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Base class for all kind of any-any mapping container. This implementation is a thread-safe wrapper around MapBasedGenericAttributeContainer!

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	m_aRWLock

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
EChange	clear() Reset the contents of the element to the after-construction state.
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.
MapBasedGenericAttributeContainerThreadSafe<KEYTYPE,VALUETYPE>	getClone()
int	hashCode()
EChange	removeAttribute(KEYTYPE aName) Remove the specified attribute from the container.
EChange	setAttribute(KEYTYPE aName, VALUETYPE aValue) Set/overwrite an attribute value.

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

onBeforeRemoveAttribute, onBeforeSetAttributeValue, setAttributes, setAttributes, 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

Methods inherited from interface com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer

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

Field Detail

m_aRWLock

protected final ReadWriteLock m_aRWLock

Constructor Detail

MapBasedGenericAttributeContainerThreadSafe

public MapBasedGenericAttributeContainerThreadSafe()

MapBasedGenericAttributeContainerThreadSafe

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

MapBasedGenericAttributeContainerThreadSafe

public MapBasedGenericAttributeContainerThreadSafe(@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.

Specified by:

containsAttribute in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

containsAttribute in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

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()

Specified by:

getAllAttributes in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

getAllAttributes in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

The non-null map with all contained attributes.

getAttributeObject

@Nullable
public VALUETYPE getAttributeObject(@Nullable
                                    KEYTYPE aName)

Description copied from interface: IGenericReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeObject in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

getAttributeObject in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

null if no such value exists

setAttribute

@Nonnull
public EChange setAttribute(@Nonnull
                           KEYTYPE aName,
                           @Nullable
                           VALUETYPE aValue)

Description copied from interface: IGenericAttributeContainer

Set/overwrite an attribute value.

Specified by:

setAttribute in interface IGenericAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

setAttribute in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - The name of the attribute. May not be null.

aValue - The value of the attribute. If it is null, the value will be removed.

Returns:

EChange.CHANGED if something changed, EChange.UNCHANGED otherwise.

See Also:

IGenericAttributeContainer.removeAttribute(Object)

removeAttribute

@Nonnull
public EChange removeAttribute(@Nullable
                              KEYTYPE aName)

Description copied from interface: IGenericAttributeContainer

Remove the specified attribute from the container.

Specified by:

removeAttribute in interface IGenericAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

removeAttribute in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - The attribute name to be removed. If it is null nothing happens.

Returns:

EChange.CHANGED if something changed, EChange.UNCHANGED otherwise.

getAttributeNames

@Nonnull
@ReturnsMutableCopy
public Enumeration<KEYTYPE> getAttributeNames()

Description copied from interface: IGenericReadonlyAttributeContainer

Get an enumerator over all contained attribute names.

Specified by:

getAttributeNames in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

getAttributeNames in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

an Enumerator over all attribute names

getAllAttributeNames

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

Specified by:

getAllAttributeNames in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

getAllAttributeNames in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

A non-null set of all attribute names.

getAllAttributeValues

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

Specified by:

getAllAttributeValues in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

getAllAttributeValues in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

A non-null collection of all attribute values.

getAttributeCount

@Nonnegative
public int getAttributeCount()

Specified by:

getAttributeCount in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

getAttributeCount in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

The number of contained attributes. Always ≥ 0.

containsNoAttribute

public boolean containsNoAttribute()

Specified by:

containsNoAttribute in interface IGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

Overrides:

containsNoAttribute in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

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

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Overrides:

clear in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

getClone

@Nonnull
public MapBasedGenericAttributeContainerThreadSafe<KEYTYPE,VALUETYPE> getClone()

Specified by:

getClone in interface ICloneable<MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>>

Overrides:

getClone in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>

hashCode

public int hashCode()

Overrides:

hashCode in class MapBasedGenericAttributeContainer<KEYTYPE,VALUETYPE>