com.helger.commons.collection.attr

Interface IMutableAttributeContainerAny<KEYTYPE>

Type Parameters:

KEYTYPE - Key type

All Superinterfaces:

IAttributeContainer<KEYTYPE,Object>, IClearable, ICommonsIterable<Map.Entry<KEYTYPE,Object>>, IMutableAttributeContainer<KEYTYPE,Object>, Iterable<Map.Entry<KEYTYPE,Object>>, Serializable

All Known Subinterfaces:

IApplicationScope, IGlobalScope, IRequestScope, IScope, ISessionApplicationScope, ISessionScope

All Known Implementing Classes:

AbstractMapBasedScope, ApplicationScope, GlobalScope, MapBasedAttributeContainerAny, RequestScope, SessionApplicationScope, SessionScope

public interface IMutableAttributeContainerAny<KEYTYPE>
extends IMutableAttributeContainer<KEYTYPE,Object>

This is the writable extension of the <String, Object>. null values are not allowed in this attribute containers.

Author:

Philip Helger

Method Summary

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

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

computeIfAbsent, removeAttribute, setAttribute, setAttributes, setAttributes

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

containsAttribute, forAllAttributes, forAllAttributeValues, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute, isEmpty, isNotEmpty, iterator

Methods inherited from interface com.helger.commons.collection.ext.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstMapped, findFirstMapped, forEach, forEach, forEachBreakable, getIteratorCount, getIteratorCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

clear

Method Detail

setAttribute

@Nonnull
default EChange setAttribute(@Nonnull
                                       KEYTYPE 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:

IMutableAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
default EChange setAttribute(@Nonnull
                                       KEYTYPE 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:

IMutableAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
default EChange setAttribute(@Nonnull
                                       KEYTYPE 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:

IMutableAttributeContainer.removeAttribute(Object)

setAttribute

@Nonnull
default EChange setAttribute(@Nonnull
                                       KEYTYPE 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:

IMutableAttributeContainer.removeAttribute(Object)

getAndSetAttributeFlag

default boolean getAndSetAttributeFlag(@Nonnull
                                       KEYTYPE aName)

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.

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.