com.helger.commons.collection.attr

Interface IAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Superinterfaces:

Serializable

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface IAttributeContainer<KEYTYPE,VALUETYPE>
extends Serializable

Base interface for a generic read-only attribute container. It maps keys to values.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	containsAttribute(KEYTYPE aName) Check if an attribute of the given name is contained.
boolean	containsNoAttribute()
Set<KEYTYPE>	getAllAttributeNames()
Map<KEYTYPE,VALUETYPE>	getAllAttributes()
Collection<VALUETYPE>	getAllAttributeValues()
BigDecimal	getAttributeAsBigDecimal(KEYTYPE aName) Get the attribute value associated to the given attribute name.
BigDecimal	getAttributeAsBigDecimal(KEYTYPE aName, BigDecimal aDefault) Get the attribute value associated to the given attribute name.
BigInteger	getAttributeAsBigInteger(KEYTYPE aName) Get the attribute value associated to the given attribute name.
BigInteger	getAttributeAsBigInteger(KEYTYPE aName, BigInteger aDefault) Get the attribute value associated to the given attribute name.
boolean	getAttributeAsBoolean(KEYTYPE aName) Get the attribute value associated to the given attribute name.
boolean	getAttributeAsBoolean(KEYTYPE aName, boolean bDefault) Get the attribute value associated to the given attribute name.
double	getAttributeAsDouble(KEYTYPE aName) Get the attribute value associated to the given attribute name.
double	getAttributeAsDouble(KEYTYPE aName, double dDefault) Get the attribute value associated to the given attribute name.
int	getAttributeAsInt(KEYTYPE aName) Get the attribute value associated to the given attribute name.
int	getAttributeAsInt(KEYTYPE aName, int nDefault) Get the attribute value associated to the given attribute name.
long	getAttributeAsLong(KEYTYPE aName) Get the attribute value associated to the given attribute name.
long	getAttributeAsLong(KEYTYPE aName, long nDefault) Get the attribute value associated to the given attribute name.
String	getAttributeAsString(KEYTYPE aName) Get the attribute value associated to the given attribute name.
String	getAttributeAsString(KEYTYPE aName, String sDefault) Get the attribute value associated to the given attribute name or the passed default value if no such attribute is present.
int	getAttributeCount()
VALUETYPE	getAttributeObject(KEYTYPE aName) Get the attribute value associated to the given attribute name.
<DATATYPE> DATATYPE	getCastedAttribute(KEYTYPE aName) Get the attribute value associated to the given attribute name.
<DATATYPE> DATATYPE	getCastedAttribute(KEYTYPE aName, DATATYPE aDefault) Get the attribute value associated to the given attribute name.
Iterator<Map.Entry<KEYTYPE,VALUETYPE>>	getIterator()
<DATATYPE> DATATYPE	getTypedAttribute(KEYTYPE aName, Class<DATATYPE> aDstClass) Get the attribute value associated to the given attribute name.
<DATATYPE> DATATYPE	getTypedAttribute(KEYTYPE aName, Class<DATATYPE> aDstClass, DATATYPE aDefault) Get the attribute value associated to the given attribute name.

Method Detail

getAttributeCount

@Nonnegative
int getAttributeCount()

Returns:

The number of contained attributes. Always ≥ 0.

containsNoAttribute

boolean containsNoAttribute()

Returns:

true if this attribute container does not contain any attribute at all, false if at least one attribute is contained.

containsAttribute

boolean containsAttribute(@Nullable
                          KEYTYPE aName)

Check if an attribute of the given name is contained.

Parameters:

aName - name of the attribute to check

Returns:

true if the attribute is contained, false otherwise

getAllAttributes

@Nonnull
 @ReturnsMutableCopy
Map<KEYTYPE,VALUETYPE> getAllAttributes()

Returns:

The non-null map with all contained attributes.

getAttributeObject

@Nullable
VALUETYPE getAttributeObject(@Nullable
                                        KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

null if no such value exists

getCastedAttribute

@Nullable
<DATATYPE> DATATYPE getCastedAttribute(@Nullable
                                                  KEYTYPE aName)

Get the attribute value associated to the given attribute name. If the type of the attribute in the scope does not match, a ClassCastException is thrown! If you just want to retrieve a String, use getAttributeAsString(Object)!
This call is identical to the call getCastedAttribute(aName, null)

Type Parameters:

DATATYPE - return type

Parameters:

aName - the attribute name

Returns:

null if no such value exists

getCastedAttribute

@Nullable
<DATATYPE> DATATYPE getCastedAttribute(@Nullable
                                                  KEYTYPE aName,
                                                  @Nullable
                                                  DATATYPE aDefault)

Get the attribute value associated to the given attribute name. If the type of the attribute in the scope does not match, a ClassCastException is thrown! If you just want to retrieve a String, use getAttributeAsString(Object, String)!

Type Parameters:

DATATYPE - return type

Parameters:

aName - The attribute name.

aDefault - The default value to be returned if no such attribute exists

Returns:

The passed default value if no such attribute exists

getTypedAttribute

@Nullable
<DATATYPE> DATATYPE getTypedAttribute(@Nullable
                                                 KEYTYPE aName,
                                                 @Nonnull
                                                 Class<DATATYPE> aDstClass)

Get the attribute value associated to the given attribute name. If the type of the attribute in the scope does not match, the TypeConverter is invoked! If you just want to retrieve a String, use getAttributeAsString(Object)!
This call is identical to the call getTypedAttribute(aName, null)

Type Parameters:

DATATYPE - return type

Parameters:

aName - the attribute name

aDstClass - The destination class to convert to. May not be null.

Returns:

null if no such value exists

getTypedAttribute

@Nullable
<DATATYPE> DATATYPE getTypedAttribute(@Nullable
                                                 KEYTYPE aName,
                                                 @Nonnull
                                                 Class<DATATYPE> aDstClass,
                                                 @Nullable
                                                 DATATYPE aDefault)

Get the attribute value associated to the given attribute name. If the type of the attribute in the scope does not match, the TypeConverter is invoked! If you just want to retrieve a String, use getAttributeAsString(Object, String)!

Type Parameters:

DATATYPE - return type

Parameters:

aName - The attribute name.

aDstClass - The destination class to convert to. May not be null.

aDefault - The default value to be returned if no such attribute exists

Returns:

The passed default value if no such attribute exists

getAttributeAsString

@Nullable
String getAttributeAsString(@Nullable
                                       KEYTYPE aName)

Get the attribute value associated to the given attribute name.
This is a shortcut for the following call: getAttributeAsString (aName, null)

Parameters:

aName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAttributeAsString

@Nullable
String getAttributeAsString(@Nullable
                                       KEYTYPE aName,
                                       @Nullable
                                       String sDefault)

Get the attribute value associated to the given attribute name or the passed default value if no such attribute is present.

Parameters:

aName - the attribute name

sDefault - The default value to be returned, if the passed attribute name is unknown

Returns:

The attribute value or sDefault if no such attribute exists

getAttributeAsInt

int getAttributeAsInt(@Nullable
                      KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

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

getAttributeAsInt

int getAttributeAsInt(@Nullable
                      KEYTYPE aName,
                      int nDefault)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

nDefault - the default value to be returned if the value is not present or not convertible

Returns:

The attribute value or nDefault if no such attribute exists

getAttributeAsLong

long getAttributeAsLong(@Nullable
                        KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

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

getAttributeAsLong

long getAttributeAsLong(@Nullable
                        KEYTYPE aName,
                        long nDefault)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

nDefault - the default value to be returned if the value is not present or not convertible

Returns:

The attribute value or nDefault if no such attribute exists

getAttributeAsDouble

double getAttributeAsDouble(@Nullable
                            KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

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

getAttributeAsDouble

double getAttributeAsDouble(@Nullable
                            KEYTYPE aName,
                            double dDefault)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

dDefault - the default value to be returned if the value is not present or not convertible

Returns:

The attribute value or nDefault if no such attribute exists

getAttributeAsBoolean

boolean getAttributeAsBoolean(@Nullable
                              KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

The attribute value or false if no such attribute exists

getAttributeAsBoolean

boolean getAttributeAsBoolean(@Nullable
                              KEYTYPE aName,
                              boolean bDefault)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

bDefault - the default value to be returned if the value is not present or not convertible

Returns:

The attribute value or bDefault if no such attribute exists

getAttributeAsBigInteger

@Nullable
BigInteger getAttributeAsBigInteger(@Nullable
                                               KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAttributeAsBigInteger

@Nullable
BigInteger getAttributeAsBigInteger(@Nullable
                                               KEYTYPE aName,
                                               @Nullable
                                               BigInteger aDefault)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

aDefault - the default value to be returned if the value is not present or not convertible

Returns:

The attribute value or aDefault if no such attribute exists

getAttributeAsBigDecimal

@Nullable
BigDecimal getAttributeAsBigDecimal(@Nullable
                                               KEYTYPE aName)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAttributeAsBigDecimal

@Nullable
BigDecimal getAttributeAsBigDecimal(@Nullable
                                               KEYTYPE aName,
                                               @Nullable
                                               BigDecimal aDefault)

Get the attribute value associated to the given attribute name.

Parameters:

aName - the attribute name

aDefault - the default value to be returned if the value is not present or not convertible

Returns:

The attribute value or aDefault if no such attribute exists

getAllAttributeNames

@Nonnull
 @ReturnsMutableCopy
Set<KEYTYPE> getAllAttributeNames()

Returns:

A non-null set of all attribute names.

getAllAttributeValues

@Nonnull
 @ReturnsMutableCopy
Collection<VALUETYPE> getAllAttributeValues()

Returns:

A non-null collection of all attribute values.

getIterator

@Nonnull
Iterator<Map.Entry<KEYTYPE,VALUETYPE>> getIterator()

Returns:

An iterator over all entries.