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>, ICloneable<MapBasedAttributeContainer<KEYTYPE,VALUETYPE>>, Serializable

Direct Known Subclasses:

MapBasedAttributeContainerAny

@NotThreadSafe
public class MapBasedAttributeContainer<KEYTYPE,VALUETYPE>
extends MapBasedReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>
implements 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

Methods

Modifier and Type	Method and Description
EChange	clear()
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)
EChange	setAttribute(KEYTYPE aName, VALUETYPE aValue)
EChange	setAttributes(IAttributeContainer<? extends KEYTYPE,? extends VALUETYPE> aValues)
EChange	setAttributes(Map<? extends KEYTYPE,? extends VALUETYPE> aValues)
String	toString()

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

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

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

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)

setAttributes

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

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)

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)

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

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>