com.phloc.commons.collections.attrs

Class MapBasedAttributeContainer

java.lang.Object

com.phloc.commons.collections.attrs.AbstractReadonlyAttributeContainer

com.phloc.commons.collections.attrs.MapBasedAttributeContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

MapBasedAttributeContainerThreadSafe

@NotThreadSafe
public class MapBasedAttributeContainer
extends AbstractReadonlyAttributeContainer
implements IAttributeContainer, ICloneable<MapBasedAttributeContainer>

Base class for all kind of string-object mapping container. This implementation is not thread-safe!

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapBasedAttributeContainer()
MapBasedAttributeContainer(IReadonlyAttributeContainer aCont)
MapBasedAttributeContainer(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.
MapBasedAttributeContainer	getClone()
int	hashCode()
protected EContinue	onBeforeRemoveAttribute(String sName) Internal callback method that can be used to avoid removal of an attribute.
protected EContinue	onBeforeSetAttributeValue(String sName, Object aValue) Internal callback method that can be used to check constraints on an attribute name or value.
EChange	removeAttribute(String sName) Remove the specified attribute from the container.
EChange	setAttribute(String sName, boolean dValue) Set/overwrite an in attribute value.
EChange	setAttribute(String sName, double dValue) Set/overwrite an in attribute value.
EChange	setAttribute(String sName, int nValue) Set/overwrite an in attribute value.
EChange	setAttribute(String sName, long nValue) Set/overwrite an in attribute value.
EChange	setAttribute(String sName, Object aValue) Set/overwrite an attribute value.
EChange	setAttributes(IReadonlyAttributeContainer aValues) Set/overwrite an arbitrary number of attribute values.
EChange	setAttributes(Map<String,?> aValues) Set/overwrite an arbitrary number of attribute values.
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

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

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

Constructor Detail

MapBasedAttributeContainer

public MapBasedAttributeContainer()

MapBasedAttributeContainer

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

MapBasedAttributeContainer

public MapBasedAttributeContainer(@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

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

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

Parameters:

sName - the attribute name

Returns:

null if no such value exists

onBeforeSetAttributeValue

@OverrideOnDemand
@Nonnull
protected EContinue onBeforeSetAttributeValue(@Nonnull
                                                           String sName,
                                                           @Nonnull
                                                           Object aValue)

Internal callback method that can be used to check constraints on an attribute name or value.

Parameters:

sName - The attribute name. Never null.

aValue - The attribute value. Never null.

Returns:

EContinue.CONTINUE to indicate that the name-value-pair is OK. May not be null.

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

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)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           String sName,
                           boolean dValue)

Description copied from interface: IAttributeContainer

Set/overwrite an in attribute value. This is a shortcut for setAttribute (sName, Boolean.valueOf (bValue));

Specified by:

setAttribute in interface IAttributeContainer

Parameters:

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

dValue - The value of the attribute.

Returns:

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

See Also:

IAttributeContainer.removeAttribute(String)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           String sName,
                           int nValue)

Description copied from interface: IAttributeContainer

Set/overwrite an in attribute value. This is a shortcut for setAttribute (sName, Integer.valueOf (nValue));

Specified by:

setAttribute in interface IAttributeContainer

Parameters:

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

nValue - The value of the attribute.

Returns:

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

See Also:

IAttributeContainer.removeAttribute(String)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           String sName,
                           long nValue)

Description copied from interface: IAttributeContainer

Set/overwrite an in attribute value. This is a shortcut for setAttribute (sName, Long.valueOf (nValue));

Specified by:

setAttribute in interface IAttributeContainer

Parameters:

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

nValue - The value of the attribute.

Returns:

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

See Also:

IAttributeContainer.removeAttribute(String)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           String sName,
                           double dValue)

Description copied from interface: IAttributeContainer

Set/overwrite an in attribute value. This is a shortcut for setAttribute (sName, Double.valueOf (nValue));

Specified by:

setAttribute in interface IAttributeContainer

Parameters:

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

dValue - The value of the attribute.

Returns:

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

See Also:

IAttributeContainer.removeAttribute(String)

setAttributes

@Nonnull
public final EChange setAttributes(@Nullable
                            Map<String,?> aValues)

Description copied from interface: IAttributeContainer

Set/overwrite an arbitrary number of attribute values.

Specified by:

setAttributes in interface IAttributeContainer

Parameters:

aValues - The map of attributes to be set. May be null.

Returns:

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

See Also:

IAttributeContainer.setAttribute(String,Object)

setAttributes

@Nonnull
public final EChange setAttributes(@Nullable
                            IReadonlyAttributeContainer aValues)

Description copied from interface: IAttributeContainer

Set/overwrite an arbitrary number of attribute values.

Specified by:

setAttributes in interface IAttributeContainer

Parameters:

aValues - The attributes to be set. May be null.

Returns:

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

See Also:

IAttributeContainer.setAttribute(String,Object)

onBeforeRemoveAttribute

@OverrideOnDemand
@Nonnull
protected EContinue onBeforeRemoveAttribute(@Nonnull
                                                         String sName)

Internal callback method that can be used to avoid removal of an attribute.

Parameters:

sName - The attribute name. Never null.

Returns:

EContinue.CONTINUE to indicate that the name-value-pair is OK. May not be null.

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

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

Description copied from interface: IReadonlyAttributeContainer

Get an enumerator over all contained attribute names.

Specified by:

getAttributeNames in interface IReadonlyAttributeContainer

Returns:

an Enumerator over all attribute names

getAllAttributeNames

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

Specified by:

getAllAttributeNames in interface IReadonlyAttributeContainer

Returns:

A non-null set of all attribute names.

getAllAttributeValues

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

Specified by:

getAllAttributeValues in interface IReadonlyAttributeContainer

Returns:

A non-null collection of all attribute values.

getAttributeCount

@Nonnegative
public int getAttributeCount()

Specified by:

getAttributeCount in interface IReadonlyAttributeContainer

Returns:

The number of contained attributes. Always ≥ 0.

containsNoAttribute

public boolean containsNoAttribute()

Specified by:

containsNoAttribute in interface IReadonlyAttributeContainer

Returns:

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

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

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.

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

Returns:

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

getClone

@Nonnull
public MapBasedAttributeContainer getClone()

Specified by:

getClone in interface ICloneable<MapBasedAttributeContainer>

Returns:

A 100% deep-copy of the implementing class.

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