com.phloc.commons.collections.attrs

Interface IAttributeContainer

All Superinterfaces:

IClearable, IReadonlyAttributeContainer, Serializable

All Known Implementing Classes:

MapBasedAttributeContainer, MapBasedAttributeContainerThreadSafe

public interface IAttributeContainer
extends IReadonlyAttributeContainer, IClearable

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

Author:

Philip Helger

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).
EChange	removeAttribute(String sName) Remove the specified attribute from the container.
EChange	setAttribute(String sName, boolean bValue) 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.

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

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

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

clear

Method Detail

setAttribute

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

Set/overwrite an attribute value.

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:

removeAttribute(String)

setAttribute

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

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

Parameters:

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

removeAttribute(String)

setAttribute

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

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

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
EChange setAttribute(@Nonnull
                           String sName,
                           long nValue)

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

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
EChange setAttribute(@Nonnull
                           String sName,
                           double dValue)

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

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)

setAttributes

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

Set/overwrite an arbitrary number of attribute values.

Parameters:

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

Returns:

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

See Also:

setAttribute(String,Object)

setAttributes

@Nonnull
EChange setAttributes(@Nullable
                            IReadonlyAttributeContainer aValues)

Set/overwrite an arbitrary number of attribute values.

Parameters:

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

Returns:

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

See Also:

setAttribute(String,Object)

removeAttribute

@Nonnull
EChange removeAttribute(@Nullable
                              String sName)

Remove the specified attribute from the container.

Parameters:

sName - The attribute name to be removed. If it is null nothing happens.

Returns:

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

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. IReadonlyAttributeContainer.containsAttribute(String) 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.