com.helger.commons.collections.attrs

Class MapBasedAttributeContainer

java.lang.Object

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

com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

com.helger.commons.collections.attrs.MapBasedAttributeContainer

All Implemented Interfaces:

IAttributeContainer, IGenericAttributeContainer<String,Object>, IGenericReadonlyAttributeContainer<String,Object>, IReadonlyAttributeContainer, ICloneable<MapBasedGenericAttributeContainer<String,Object>>, IClearable, Serializable

Direct Known Subclasses:

MapBasedAttributeContainerThreadSafe

@NotThreadSafe
public class MapBasedAttributeContainer
extends MapBasedGenericAttributeContainer<String,Object>
implements IAttributeContainer

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(IGenericReadonlyAttributeContainer<? extends String,? extends Object> aCont)
MapBasedAttributeContainer(Map<? extends String,? extends Object> aMap)
MapBasedAttributeContainer(String sKey, Object aValue)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAndSetAttributeFlag(String sName) Atomic operation to set a flag to true if it was previously set to false (meaning not existing).
MapBasedAttributeContainer	getClone()
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.

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

clear, containsAttribute, containsNoAttribute, equals, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeNames, getAttributeObject, hashCode, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, 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.IGenericAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

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

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeNames, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from interface com.helger.commons.state.IClearable

clear

Constructor Detail

MapBasedAttributeContainer

public MapBasedAttributeContainer()

MapBasedAttributeContainer

public MapBasedAttributeContainer(@Nonnull
                          String sKey,
                          @Nullable
                          Object aValue)

MapBasedAttributeContainer

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

MapBasedAttributeContainer

public MapBasedAttributeContainer(@Nonnull
                          IGenericReadonlyAttributeContainer<? extends String,? extends Object> aCont)

Method Detail

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 (aName, 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:

#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 (aName, 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:

#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 (aName, 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:

#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 (aName, 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:

#removeAttribute(String)

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. #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.

getClone

public MapBasedAttributeContainer getClone()

Specified by:

getClone in interface ICloneable<MapBasedGenericAttributeContainer<String,Object>>

Overrides:

getClone in class MapBasedGenericAttributeContainer<String,Object>

Returns:

A 100% deep-copy of the implementing class.