com.phloc.commons.collections.attrs

Class MapBasedAttributeContainerThreadSafe

java.lang.Object

com.phloc.commons.collections.attrs.AbstractReadonlyAttributeContainer

com.phloc.commons.collections.attrs.MapBasedAttributeContainer

com.phloc.commons.collections.attrs.MapBasedAttributeContainerThreadSafe

All Implemented Interfaces:

IAttributeContainer, IReadonlyAttributeContainer, ICloneable<MapBasedAttributeContainer>, IClearable, Serializable

@ThreadSafe
public class MapBasedAttributeContainerThreadSafe
extends MapBasedAttributeContainer

Base class for all kind of string-object mapping container. This implementation is a thread-safe wrapper around MapBasedAttributeContainer!

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
MapBasedAttributeContainerThreadSafe()
MapBasedAttributeContainerThreadSafe(IReadonlyAttributeContainer aCont)
MapBasedAttributeContainerThreadSafe(Map<String,?> 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(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()
boolean	getAndSetAttributeFlag(String sName) Atomic operation to set a flag to true if it was previously set to false (meaning not existing).
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.
MapBasedAttributeContainerThreadSafe	getClone()
int	hashCode()
EChange	removeAttribute(String sName) Remove the specified attribute from the container.
EChange	setAttribute(String sName, Object aValue) Set/overwrite an attribute value.
String	toString()

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

onBeforeRemoveAttribute, onBeforeSetAttributeValue, setAttribute, setAttribute, setAttribute, setAttribute, setAttributes, setAttributes

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

Methods inherited from interface com.phloc.commons.collections.attrs.IReadonlyAttributeContainer

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

MapBasedAttributeContainerThreadSafe

public MapBasedAttributeContainerThreadSafe()

MapBasedAttributeContainerThreadSafe

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

MapBasedAttributeContainerThreadSafe

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

Specified by:

containsAttribute in interface IReadonlyAttributeContainer

Overrides:

containsAttribute in class MapBasedAttributeContainer

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

Specified by:

getAllAttributes in interface IReadonlyAttributeContainer

Overrides:

getAllAttributes in class MapBasedAttributeContainer

Returns:

The non-null map with all contained attributes.

getAttributeObject

@Nullable
public Object getAttributeObject(@Nullable
                                 String sName)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeObject in interface IReadonlyAttributeContainer

Overrides:

getAttributeObject in class MapBasedAttributeContainer

Parameters:

sName - the attribute name

Returns:

null if no such value exists

setAttribute

@Nonnull
public EChange setAttribute(@Nonnull
                           String sName,
                           @Nullable
                           Object aValue)

Description copied from interface: IAttributeContainer

Set/overwrite an attribute value.

Specified by:

setAttribute in interface IAttributeContainer

Overrides:

setAttribute in class MapBasedAttributeContainer

Parameters:

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

IAttributeContainer.removeAttribute(String)

removeAttribute

@Nonnull
public EChange removeAttribute(@Nullable
                              String sName)

Description copied from interface: IAttributeContainer

Remove the specified attribute from the container.

Specified by:

removeAttribute in interface IAttributeContainer

Overrides:

removeAttribute in class MapBasedAttributeContainer

Parameters:

sName - 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<String> getAttributeNames()

Description copied from interface: IReadonlyAttributeContainer

Get an enumerator over all contained attribute names.

Specified by:

getAttributeNames in interface IReadonlyAttributeContainer

Overrides:

getAttributeNames in class MapBasedAttributeContainer

Returns:

an Enumerator over all attribute names

getAllAttributeNames

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

Specified by:

getAllAttributeNames in interface IReadonlyAttributeContainer

Overrides:

getAllAttributeNames in class MapBasedAttributeContainer

Returns:

A non-null set of all attribute names.

getAllAttributeValues

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

Specified by:

getAllAttributeValues in interface IReadonlyAttributeContainer

Overrides:

getAllAttributeValues in class MapBasedAttributeContainer

Returns:

A non-null collection of all attribute values.

getAttributeCount

@Nonnegative
public int getAttributeCount()

Specified by:

getAttributeCount in interface IReadonlyAttributeContainer

Overrides:

getAttributeCount in class MapBasedAttributeContainer

Returns:

The number of contained attributes. Always ≥ 0.

containsNoAttribute

public boolean containsNoAttribute()

Specified by:

containsNoAttribute in interface IReadonlyAttributeContainer

Overrides:

containsNoAttribute in class MapBasedAttributeContainer

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 MapBasedAttributeContainer

Returns:

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

getAndSetAttributeFlag

public boolean getAndSetAttributeFlag(@Nonnull
                             String sName)

Description copied from interface: IAttributeContainer

Atomic operation to set a flag to true if it was previously set to false (meaning not existing). There is no possibility to define a value for this flag. The value used is Boolean.TRUE. IReadonlyAttributeContainer.containsAttribute(String) can be used to check if the attribute is already present.

Specified by:

getAndSetAttributeFlag in interface IAttributeContainer

Overrides:

getAndSetAttributeFlag in class MapBasedAttributeContainer

Parameters:

sName - The name of the flag to set.

Returns:

The old value of the flag. If the flag was not present previously, than false is returned, whereas if the flag was already present, true is returned. Any other than the first call for the same flag is always returning true.

getClone

@Nonnull
public MapBasedAttributeContainerThreadSafe getClone()

Specified by:

getClone in interface ICloneable<MapBasedAttributeContainer>

Overrides:

getClone in class MapBasedAttributeContainer

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class MapBasedAttributeContainer

hashCode

public int hashCode()

Overrides:

hashCode in class MapBasedAttributeContainer

toString

public String toString()

Overrides:

toString in class MapBasedAttributeContainer