com.helger.commons.collection.attr

Interface IMutableAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Superinterfaces:

IAttributeContainer<KEYTYPE,VALUETYPE>, IClearable, Serializable

All Known Subinterfaces:

IApplicationScope, IGlobalScope, IMutableAttributeContainerAny<KEYTYPE>, IRequestScope, IScope, ISessionApplicationScope, ISessionScope

All Known Implementing Classes:

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

public interface IMutableAttributeContainer<KEYTYPE,VALUETYPE>
extends IAttributeContainer<KEYTYPE,VALUETYPE>, IClearable

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

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
EChange	removeAttribute(KEYTYPE aName) Remove the specified attribute from the container.
EChange	setAttribute(KEYTYPE aName, VALUETYPE aValue) Set/overwrite an attribute value.
EChange	setAttributes(IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aValues) Set/overwrite an arbitrary number of attribute values.
EChange	setAttributes(Map<? extends KEYTYPE,? extends VALUETYPE> aValues) Set/overwrite an arbitrary number of attribute values.

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, getIterator, getTypedAttribute, getTypedAttribute

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

clear

Method Detail

setAttribute

@Nonnull
EChange setAttribute(@Nonnull
                               KEYTYPE aName,
                               @Nullable
                               VALUETYPE aValue)

Set/overwrite an attribute value.

Parameters:

aName - 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(Object)

setAttributes

@Nonnull
EChange setAttributes(@Nullable
                                Map<? extends KEYTYPE,? extends VALUETYPE> 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(Object,Object)

setAttributes

@Nonnull
EChange setAttributes(@Nullable
                                IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> 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(Object,Object)

removeAttribute

@Nonnull
EChange removeAttribute(@Nullable
                                  KEYTYPE aName)

Remove the specified attribute from the container.

Parameters:

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

Returns:

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