com.helger.commons.collection.attr

Interface IAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Superinterfaces:

ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>, ICommonsMap<KEYTYPE,VALUETYPE>, IGetterByKeyTrait<KEYTYPE>, Map<KEYTYPE,VALUETYPE>, Serializable

All Known Subinterfaces:

IAttributeContainerAny<KEYTYPE>, IStringMap

All Known Implementing Classes:

AttributeContainer, AttributeContainerAny, AttributeContainerAnyConcurrent, AttributeContainerConcurrent, StringMap

public interface IAttributeContainer<KEYTYPE,VALUETYPE>
extends ICommonsMap<KEYTYPE,VALUETYPE>, IGetterByKeyTrait<KEYTYPE>

Base interface for a generic read-only attribute container. It maps keys to values.
Note: don't implement Iterable<Map.Entry<...>> because this would make the object ambiguous to e.g. HashCodeGenerator

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IAttributeContainer.IAfterSetValueCallback<KEYTYPE,VALUETYPE>
static interface	IAttributeContainer.IBeforeSetValueCallback<KEYTYPE,VALUETYPE>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
CallbackList<IAttributeContainer.IAfterSetValueCallback<KEYTYPE,VALUETYPE>>	afterSetValueCallbacks()
CallbackList<IAttributeContainer.IBeforeSetValueCallback<KEYTYPE,VALUETYPE>>	beforeSetValueCallbacks()
default boolean	getAsBoolean(KEYTYPE aName) Get the attribute value associated to the given attribute name.
default double	getAsDouble(KEYTYPE aName) Get the attribute value associated to the given attribute name.
default float	getAsFloat(KEYTYPE aName) Get the attribute value associated to the given attribute name.
default int	getAsInt(KEYTYPE aName) Get the attribute value associated to the given attribute name.
default long	getAsLong(KEYTYPE aName) Get the attribute value associated to the given attribute name.
IAttributeContainer<KEYTYPE,VALUETYPE>	getClone()
default VALUETYPE	getValue(KEYTYPE aName) Get the attribute value associated to the given attribute name.
default EChange	putAllIn(Map<? extends KEYTYPE,? extends VALUETYPE> aAttrs)
default EChange	putIn(KEYTYPE aName, VALUETYPE aNewValue) Set/overwrite an attribute value including before and after callbacks.

Methods inherited from interface com.helger.commons.collection.impl.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfEntrySet, copyOfKeySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, createInstance, findFirstEntry, findFirstKey, findFirstValue, forEach, forEachKey, forEachKey, forEachValue, forEachValue, getAsUnmodifiable, getFirstEntry, getFirstEntry, getFirstKey, getFirstKey, getFirstValue, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, put, putAll, putAll, putAllMapped, putAllMapped, putAllMapped, putIf, putIfNotNull, removeAll, removeIf, removeIfKey, removeIfValue, removeObject, setAll

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface com.helger.commons.traits.IGetterByKeyTrait

containsNonNullValue, containsNullValue, getAsBigDecimal, getAsBigDecimal, getAsBigInteger, getAsBigInteger, getAsBoolean, getAsBooleanObj, getAsByte, getAsByte, getAsByteArray, getAsByteObj, getAsChar, getAsChar, getAsCharArray, getAsCharArray, getAsCharObj, getAsDouble, getAsDoubleObj, getAsFloat, getAsFloatObj, getAsInt, getAsIntObj, getAsLocalDate, getAsLocalDate, getAsLocalDate, getAsLocalDateTime, getAsLocalDateTime, getAsLocalDateTime, getAsLocalTime, getAsLocalTime, getAsLocalTime, getAsLong, getAsLongObj, getAsShort, getAsShort, getAsShortObj, getAsSqlBlob, getAsSqlClob, getAsSqlDate, getAsSqlNClob, getAsSqlRowId, getAsSqlTime, getAsSqlTimestamp, getAsString, getAsString, getAsStringList, getAsStringList, getAsStringSet, getAsStringSet, getCastedValue, getCastedValue, getCastedValue, getCastedValue, getConvertedValue, getConvertedValue, getSafeCastedValue, getSafeCastedValue, getValueClass, hasStringValue, hasStringValue, onSafeCastError

Method Detail

getValue

@Nullable
default VALUETYPE getValue(@Nullable
                                      KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Specified by:

getValue in interface IGetterByKeyTrait<KEYTYPE>

Parameters:

aName - the attribute name

Returns:

null if no such value exists

getAsInt

default int getAsInt(@Nullable
                     KEYTYPE aName)

Get the attribute value associated to the given attribute name.
Avoid throwing TypeConverterException by providing a default value.

Specified by:

getAsInt in interface IGetterByKeyTrait<KEYTYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or CGlobal.ILLEGAL_UINT if no such attribute exists

getAsLong

default long getAsLong(@Nullable
                       KEYTYPE aName)

Get the attribute value associated to the given attribute name.
Avoid throwing TypeConverterException by providing a default value.

Specified by:

getAsLong in interface IGetterByKeyTrait<KEYTYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or CGlobal.ILLEGAL_ULONG if no such attribute exists

getAsFloat

default float getAsFloat(@Nullable
                         KEYTYPE aName)

Get the attribute value associated to the given attribute name.
Avoid throwing TypeConverterException by providing a default value.

Specified by:

getAsFloat in interface IGetterByKeyTrait<KEYTYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or CGlobal.ILLEGAL_UINT if no such attribute exists

getAsDouble

default double getAsDouble(@Nullable
                           KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Specified by:

getAsDouble in interface IGetterByKeyTrait<KEYTYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or CGlobal.ILLEGAL_UINT if no such attribute exists

getAsBoolean

default boolean getAsBoolean(@Nullable
                             KEYTYPE aName)

Get the attribute value associated to the given attribute name.
Avoid throwing TypeConverterException by providing a default value.

Specified by:

getAsBoolean in interface IGetterByKeyTrait<KEYTYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or false if no such attribute exists

beforeSetValueCallbacks

@Nonnull
 @ReturnsMutableObject
CallbackList<IAttributeContainer.IBeforeSetValueCallback<KEYTYPE,VALUETYPE>> beforeSetValueCallbacks()

Returns:

Callbacks to be invoked before values are set. May not be null.

afterSetValueCallbacks

@Nonnull
 @ReturnsMutableObject
CallbackList<IAttributeContainer.IAfterSetValueCallback<KEYTYPE,VALUETYPE>> afterSetValueCallbacks()

Returns:

Callbacks to be invoked after values are set. May not be null.

putIn

@Nonnull
default EChange putIn(@Nonnull
                                KEYTYPE aName,
                                @Nullable
                                VALUETYPE aNewValue)

Set/overwrite an attribute value including before and after callbacks.

Parameters:

aName - The name of the attribute. May not be null.

aNewValue - The new value of the attribute. May be null.

Returns:

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

See Also:

beforeSetValueCallbacks(), afterSetValueCallbacks(), ICommonsMap.removeObject(Object)

putAllIn

@Nonnull
default EChange putAllIn(@Nullable
                                   Map<? extends KEYTYPE,? extends VALUETYPE> aAttrs)

getClone

@Nonnull
 @ReturnsMutableCopy
IAttributeContainer<KEYTYPE,VALUETYPE> getClone()

Specified by:

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

Returns:

A 100% deep-copy of the implementing class.