com.helger.commons.collections.attrs

Interface IAttributeContainer

All Superinterfaces:

IClearable, IGenericAttributeContainer<String,Object>, IGenericReadonlyAttributeContainer<String,Object>, IReadonlyAttributeContainer, Serializable

All Known Subinterfaces:

IApplicationScope, IGlobalScope, IRequestScope, IScope, ISessionApplicationScope, ISessionScope

All Known Implementing Classes:

AbstractMapBasedScope, ApplicationScope, GlobalScope, MapBasedAttributeContainer, MapBasedAttributeContainerThreadSafe, RequestScope, SessionApplicationScope, SessionScope

public interface IAttributeContainer
extends IReadonlyAttributeContainer, IGenericAttributeContainer<String,Object>

This is the writable extension of the IReadonlyAttributeContainer. null values are not allowed in this attribute containers.

Author:

Philip Helger

Method Summary

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).
EChange	setAttribute(String aName, boolean bValue) Set/overwrite an in attribute value.
EChange	setAttribute(String aName, double dValue) Set/overwrite an in attribute value.
EChange	setAttribute(String aName, int nValue) Set/overwrite an in attribute value.
EChange	setAttribute(String aName, long nValue) Set/overwrite an in attribute value.

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

Method Detail

setAttribute

@Nonnull
EChange setAttribute(@Nonnull
                               String aName,
                               boolean bValue)

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

Parameters:

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

bValue - The value of the attribute.

Returns:

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

See Also:

IGenericAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
EChange setAttribute(@Nonnull
                               String aName,
                               int nValue)

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

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:

IGenericAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
EChange setAttribute(@Nonnull
                               String aName,
                               long nValue)

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

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:

IGenericAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
EChange setAttribute(@Nonnull
                               String aName,
                               double dValue)

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

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:

IGenericAttributeContainer.removeAttribute(Object)

getAndSetAttributeFlag

boolean getAndSetAttributeFlag(@Nonnull
                               String sName)

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

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.