com.helger.commons.collection.attr

Class MapBasedAttributeContainer<KEYTYPE,VALUETYPE>

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,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

IAttributeContainer<KEYTYPE,VALUETYPE>, IMutableAttributeContainer<KEYTYPE,VALUETYPE>, ICloneable<MapBasedAttributeContainer<KEYTYPE,VALUETYPE>>, IClearable, Serializable

Direct Known Subclasses:

MapBasedAttributeContainerAny

@NotThreadSafe
public class MapBasedAttributeContainer<KEYTYPE,VALUETYPE>
extends MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>
implements IMutableAttributeContainer<KEYTYPE,VALUETYPE>, ICloneable<MapBasedAttributeContainer<KEYTYPE,VALUETYPE>>

Base class for all kind of any-any 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
	MapBasedAttributeContainer()
protected	MapBasedAttributeContainer(boolean bDummy, Map<KEYTYPE,VALUETYPE> aAttrMap)
	MapBasedAttributeContainer(IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aCont)
	MapBasedAttributeContainer(KEYTYPE aKey, VALUETYPE aValue)
	MapBasedAttributeContainer(Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

Method Summary

Modifier and Type	Method and Description
EChange	clear() Reset the contents of the element to the after-construction state.
boolean	equals(Object o)
MapBasedAttributeContainer<KEYTYPE,VALUETYPE>	getClone()
int	hashCode()
protected EContinue	onBeforeRemoveAllAttributes() Internal callback method that can be used to avoid removal of all attributes.
protected EContinue	onBeforeRemoveAttribute(KEYTYPE aName) Internal callback method that can be used to avoid removal of an attribute.
protected EContinue	onBeforeSetAttributeValue(KEYTYPE aName, VALUETYPE aValue) Internal callback method that can be used to check constraints on an attribute name or value.
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.
String	toString()

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

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

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.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

Constructor Detail

MapBasedAttributeContainer

public MapBasedAttributeContainer()

MapBasedAttributeContainer

public MapBasedAttributeContainer(@Nonnull
                                  KEYTYPE aKey,
                                  @Nullable
                                  VALUETYPE aValue)

MapBasedAttributeContainer

public MapBasedAttributeContainer(@Nonnull
                                  Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

MapBasedAttributeContainer

public MapBasedAttributeContainer(@Nonnull
                                  IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aCont)

MapBasedAttributeContainer

protected MapBasedAttributeContainer(boolean bDummy,
                                     @Nonnull
                                     Map<KEYTYPE,VALUETYPE> aAttrMap)

Method Detail

setAttributes

@Nonnull
public final EChange setAttributes(@Nullable
                                             Map<? extends KEYTYPE,? extends VALUETYPE> aValues)

Description copied from interface: IMutableAttributeContainer

Set/overwrite an arbitrary number of attribute values.

Specified by:

setAttributes in interface IMutableAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

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

Returns:

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

See Also:

IMutableAttributeContainer.setAttribute(Object,Object)

setAttributes

@Nonnull
public final EChange setAttributes(@Nullable
                                             IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aValues)

Description copied from interface: IMutableAttributeContainer

Set/overwrite an arbitrary number of attribute values.

Specified by:

setAttributes in interface IMutableAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

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

Returns:

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

See Also:

IMutableAttributeContainer.setAttribute(Object,Object)

onBeforeSetAttributeValue

@OverrideOnDemand
 @Nonnull
protected EContinue onBeforeSetAttributeValue(@Nonnull
                                                                            KEYTYPE aName,
                                                                            @Nonnull
                                                                            VALUETYPE aValue)

Internal callback method that can be used to check constraints on an attribute name or value.

Parameters:

aName - The attribute name. Never null.

aValue - The attribute value. Never null.

Returns:

EContinue.CONTINUE to indicate that the name-value-pair is OK. May not be null.

setAttribute

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

Description copied from interface: IMutableAttributeContainer

Set/overwrite an attribute value.

Specified by:

setAttribute in interface IMutableAttributeContainer<KEYTYPE,VALUETYPE>

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:

IMutableAttributeContainer.removeAttribute(Object)

onBeforeRemoveAttribute

@OverrideOnDemand
 @Nonnull
protected EContinue onBeforeRemoveAttribute(@Nonnull
                                                                          KEYTYPE aName)

Internal callback method that can be used to avoid removal of an attribute.

Parameters:

aName - The attribute name. Never null.

Returns:

EContinue.CONTINUE to indicate that the operation should continue. May not be null.

removeAttribute

@Nonnull
public EChange removeAttribute(@Nullable
                                         KEYTYPE aName)

Description copied from interface: IMutableAttributeContainer

Remove the specified attribute from the container.

Specified by:

removeAttribute in interface IMutableAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

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

Returns:

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

onBeforeRemoveAllAttributes

@OverrideOnDemand
 @Nonnull
protected EContinue onBeforeRemoveAllAttributes()

Internal callback method that can be used to avoid removal of all attributes.

Returns:

EContinue.CONTINUE to indicate that the operation should continue. May not be null.

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

getClone

@Nonnull
 @ReturnsMutableCopy
public MapBasedAttributeContainer<KEYTYPE,VALUETYPE> getClone()

Specified by:

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

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

hashCode

public int hashCode()

Overrides:

hashCode in class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

toString

public String toString()

Overrides:

toString in class MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>