com.helger.commons.collection.attr

Class MapBasedAttributeContainerAny<KEYTYPE>

java.lang.Object

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

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

com.helger.commons.collection.attr.MapBasedAttributeContainer<KEYTYPE,Object>

com.helger.commons.collection.attr.MapBasedAttributeContainerAny<KEYTYPE>

Type Parameters:

KEYTYPE - Key type

All Implemented Interfaces:

IAttributeContainer<KEYTYPE,Object>, IMutableAttributeContainer<KEYTYPE,Object>, IMutableAttributeContainerAny<KEYTYPE>, ICloneable<MapBasedAttributeContainer<KEYTYPE,Object>>, IClearable, Serializable

Direct Known Subclasses:

AbstractMapBasedScope

@NotThreadSafe
public class MapBasedAttributeContainerAny<KEYTYPE>
extends MapBasedAttributeContainer<KEYTYPE,Object>
implements IMutableAttributeContainerAny<KEYTYPE>

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

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

m_aAttrs

Constructor Summary

Constructors

Modifier	Constructor and Description
	MapBasedAttributeContainerAny()
protected	MapBasedAttributeContainerAny(boolean bDummy, Map<KEYTYPE,Object> aAttrMap)
	MapBasedAttributeContainerAny(IAttributeContainer<? extends KEYTYPE,? extends Object> aCont)
	MapBasedAttributeContainerAny(KEYTYPE sKey, Object aValue)
	MapBasedAttributeContainerAny(Map<? extends KEYTYPE,? extends Object> aMap)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAndSetAttributeFlag(KEYTYPE aName) Atomic operation to set a flag to true if it was previously set to false (meaning not existing).
MapBasedAttributeContainerAny<KEYTYPE>	getClone()
EChange	setAttribute(KEYTYPE aName, boolean dValue) Set/overwrite an in attribute value.
EChange	setAttribute(KEYTYPE aName, double dValue) Set/overwrite an in attribute value.
EChange	setAttribute(KEYTYPE aName, int nValue) Set/overwrite an in attribute value.
EChange	setAttribute(KEYTYPE aName, long nValue) Set/overwrite an in attribute value.

Methods inherited from class com.helger.commons.collection.attr.MapBasedAttributeContainer

clear, equals, hashCode, onBeforeRemoveAllAttributes, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes, toString

Methods inherited from class com.helger.commons.collection.attr.MapBasedReadOnlyAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeObject

Methods inherited from class com.helger.commons.collection.attr.AbstractReadOnlyAttributeContainer

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.collection.attr.IMutableAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

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

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

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

clear

Constructor Detail

MapBasedAttributeContainerAny

public MapBasedAttributeContainerAny()

MapBasedAttributeContainerAny

public MapBasedAttributeContainerAny(@Nonnull
                             KEYTYPE sKey,
                             @Nullable
                             Object aValue)

MapBasedAttributeContainerAny

public MapBasedAttributeContainerAny(@Nonnull
                             Map<? extends KEYTYPE,? extends Object> aMap)

MapBasedAttributeContainerAny

public MapBasedAttributeContainerAny(@Nonnull
                             IAttributeContainer<? extends KEYTYPE,? extends Object> aCont)

MapBasedAttributeContainerAny

protected MapBasedAttributeContainerAny(boolean bDummy,
                             @Nonnull
                             Map<KEYTYPE,Object> aAttrMap)

Method Detail

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           KEYTYPE aName,
                           boolean dValue)

Description copied from interface: IMutableAttributeContainerAny

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

Specified by:

setAttribute in interface IMutableAttributeContainerAny<KEYTYPE>

Parameters:

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

IMutableAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           KEYTYPE aName,
                           int nValue)

Description copied from interface: IMutableAttributeContainerAny

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

Specified by:

setAttribute in interface IMutableAttributeContainerAny<KEYTYPE>

Parameters:

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

IMutableAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           KEYTYPE aName,
                           long nValue)

Description copied from interface: IMutableAttributeContainerAny

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

Specified by:

setAttribute in interface IMutableAttributeContainerAny<KEYTYPE>

Parameters:

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

IMutableAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
public final EChange setAttribute(@Nonnull
                           KEYTYPE aName,
                           double dValue)

Description copied from interface: IMutableAttributeContainerAny

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

Specified by:

setAttribute in interface IMutableAttributeContainerAny<KEYTYPE>

Parameters:

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

IMutableAttributeContainer.removeAttribute(Object)

getAndSetAttributeFlag

public boolean getAndSetAttributeFlag(@Nonnull
                             KEYTYPE aName)

Description copied from interface: IMutableAttributeContainerAny

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. IAttributeContainer.containsAttribute(Object) can be used to check if the attribute is already present.

Specified by:

getAndSetAttributeFlag in interface IMutableAttributeContainerAny<KEYTYPE>

Parameters:

aName - 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
@ReturnsMutableCopy
public MapBasedAttributeContainerAny<KEYTYPE> getClone()

Specified by:

getClone in interface ICloneable<MapBasedAttributeContainer<KEYTYPE,Object>>

Overrides:

getClone in class MapBasedAttributeContainer<KEYTYPE,Object>

Returns:

A 100% deep-copy of the implementing class.