com.helger.commons.collection.attr

Class AbstractReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

java.lang.Object

com.helger.commons.collection.attr.AbstractReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Implemented Interfaces:

IAttributeContainer<KEYTYPE,VALUETYPE>, Serializable

Direct Known Subclasses:

MapBasedReadOnlyAttributeContainer

@NotThreadSafe
public abstract class AbstractReadOnlyAttributeContainer<KEYTYPE,VALUETYPE>
extends Object
implements IAttributeContainer<KEYTYPE,VALUETYPE>

Abstract base class for all kind of string-object mapping container. This implementation provides a default implementation for all things that can be independently implemented from the underlying data structure.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractReadOnlyAttributeContainer()

Method Summary

Methods

Modifier and Type	Method and Description
static BigDecimal	getAsBigDecimal(Object aParamName, Object aValue, BigDecimal aDefault)
static BigInteger	getAsBigInteger(Object aParamName, Object aValue, BigInteger aDefault)
static boolean	getAsBoolean(Object aParamName, Object aValue, boolean bDefault)
static double	getAsDouble(Object aParamName, Object aValue, double dDefault)
static int	getAsInt(Object aParamName, Object aValue, int nDefault)
static long	getAsLong(Object aParamName, Object aValue, long nDefault)
static String	getAsString(Object aParamName, Object aValue, String sDefault) Get the string representation of the passed value, suitable for parameters.
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.
<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.
<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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

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

Constructor Detail

AbstractReadOnlyAttributeContainer

public AbstractReadOnlyAttributeContainer()

Method Detail

getCastedAttribute

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

Description copied from interface: IAttributeContainer

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 IAttributeContainer.getAttributeAsString(Object)!
This call is identical to the call getCastedAttribute(aName, null)

Specified by:

getCastedAttribute in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Type Parameters:

DATATYPE - return type

Parameters:

aName - the attribute name

Returns:

null if no such value exists

getCastedAttribute

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

Description copied from interface: IAttributeContainer

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 IAttributeContainer.getAttributeAsString(Object, String)!

Specified by:

getCastedAttribute in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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
public final <DATATYPE> DATATYPE getTypedAttribute(@Nullable
                                             KEYTYPE aName,
                                             @Nonnull
                                             Class<DATATYPE> aDstClass)

Description copied from interface: IAttributeContainer

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 IAttributeContainer.getAttributeAsString(Object)!
This call is identical to the call getTypedAttribute(aName, null)

Specified by:

getTypedAttribute in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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
public final <DATATYPE> DATATYPE getTypedAttribute(@Nullable
                                             KEYTYPE aName,
                                             @Nonnull
                                             Class<DATATYPE> aDstClass,
                                             @Nullable
                                             DATATYPE aDefault)

Description copied from interface: IAttributeContainer

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 IAttributeContainer.getAttributeAsString(Object, String)!

Specified by:

getTypedAttribute in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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
public final String getAttributeAsString(@Nullable
                                   KEYTYPE aName)

Description copied from interface: IAttributeContainer

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

Specified by:

getAttributeAsString in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAsString

@Nullable
public static String getAsString(@Nullable
                          Object aParamName,
                          @Nullable
                          Object aValue,
                          @Nullable
                          String sDefault)

Get the string representation of the passed value, suitable for parameters.

Parameters:

aParamName - The name of the parameters. Has just informal character, for warnings. May be null.

aValue - The value to be converted to a String. May be null. Explicitly supported data types are: String, String[]. All other data types are returned as "toString()".

sDefault - The default value to be returned, if the passed value is null or an empty String array.

Returns:

The default value if the value is null or an empty String array, the value as string otherwise. If the value is a String[] than the first element is returned, and the other elements are discarded.

getAttributeAsString

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

Description copied from interface: IAttributeContainer

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

Specified by:

getAttributeAsString in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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

getAsInt

public static int getAsInt(@Nullable
           Object aParamName,
           @Nullable
           Object aValue,
           int nDefault)

getAttributeAsInt

public final int getAttributeAsInt(@Nullable
                    KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsInt in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

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

getAttributeAsInt

public final int getAttributeAsInt(@Nullable
                    KEYTYPE aName,
                    int nDefault)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsInt in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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

getAsLong

public static long getAsLong(@Nullable
             Object aParamName,
             @Nullable
             Object aValue,
             long nDefault)

getAttributeAsLong

public final long getAttributeAsLong(@Nullable
                      KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsLong in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

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

getAttributeAsLong

public final long getAttributeAsLong(@Nullable
                      KEYTYPE aName,
                      long nDefault)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsLong in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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

getAsDouble

public static double getAsDouble(@Nullable
                 Object aParamName,
                 @Nullable
                 Object aValue,
                 double dDefault)

getAttributeAsDouble

public final double getAttributeAsDouble(@Nullable
                          KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsDouble in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

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

getAttributeAsDouble

public final double getAttributeAsDouble(@Nullable
                          KEYTYPE aName,
                          double dDefault)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsDouble in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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

getAsBoolean

public static boolean getAsBoolean(@Nullable
                   Object aParamName,
                   @Nullable
                   Object aValue,
                   boolean bDefault)

getAttributeAsBoolean

public final boolean getAttributeAsBoolean(@Nullable
                            KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBoolean in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or false if no such attribute exists

getAttributeAsBoolean

public final boolean getAttributeAsBoolean(@Nullable
                            KEYTYPE aName,
                            boolean bDefault)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBoolean in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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

getAsBigInteger

@Nullable
public static BigInteger getAsBigInteger(@Nullable
                                  Object aParamName,
                                  @Nullable
                                  Object aValue,
                                  @Nullable
                                  BigInteger aDefault)

getAttributeAsBigInteger

@Nullable
public final BigInteger getAttributeAsBigInteger(@Nullable
                                           KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBigInteger in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAttributeAsBigInteger

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

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBigInteger in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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

getAsBigDecimal

@Nullable
public static BigDecimal getAsBigDecimal(@Nullable
                                  Object aParamName,
                                  @Nullable
                                  Object aValue,
                                  @Nullable
                                  BigDecimal aDefault)

getAttributeAsBigDecimal

@Nullable
public final BigDecimal getAttributeAsBigDecimal(@Nullable
                                           KEYTYPE aName)

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBigDecimal in interface IAttributeContainer<KEYTYPE,VALUETYPE>

Parameters:

aName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAttributeAsBigDecimal

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

Description copied from interface: IAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBigDecimal in interface IAttributeContainer<KEYTYPE,VALUETYPE>

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