com.helger.commons.collections.attrs

Class AbstractReadonlyAttributeContainer

java.lang.Object

com.helger.commons.collections.attrs.AbstractReadonlyAttributeContainer

All Implemented Interfaces:

IReadonlyAttributeContainer, Serializable

Direct Known Subclasses:

MapBasedAttributeContainer, MapBasedReadonlyAttributeContainer

@NotThreadSafe
public abstract class AbstractReadonlyAttributeContainer
extends Object
implements IReadonlyAttributeContainer

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 boolean	getAsBoolean(String sParamName, Object aValue, boolean bDefault)
static double	getAsDouble(String sParamName, Object aValue, double dDefault)
static int	getAsInt(String sParamName, Object aValue, int nDefault)
static long	getAsLong(String sParamName, Object aValue, long nDefault)
static String	getAsString(String sParamName, Object aValue, String sDefault) Get the string representation of the passed value, suitable for parameters.
boolean	getAttributeAsBoolean(String sName) Get the attribute value associated to the given attribute name.
boolean	getAttributeAsBoolean(String sName, boolean bDefault) Get the attribute value associated to the given attribute name.
double	getAttributeAsDouble(String sName) Get the attribute value associated to the given attribute name.
double	getAttributeAsDouble(String sName, double dDefault) Get the attribute value associated to the given attribute name.
int	getAttributeAsInt(String sName) Get the attribute value associated to the given attribute name.
int	getAttributeAsInt(String sName, int nDefault) Get the attribute value associated to the given attribute name.
long	getAttributeAsLong(String sName) Get the attribute value associated to the given attribute name.
long	getAttributeAsLong(String sName, long nDefault) Get the attribute value associated to the given attribute name.
String	getAttributeAsString(String sName) Get the attribute value associated to the given attribute name.
String	getAttributeAsString(String sName, 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(String sName) Get the attribute value associated to the given attribute name.
<DATATYPE> DATATYPE	getCastedAttribute(String sName, DATATYPE aDefault) Get the attribute value associated to the given attribute name.
<DATATYPE> DATATYPE	getTypedAttribute(String sName, Class<DATATYPE> aDstClass) Get the attribute value associated to the given attribute name.
<DATATYPE> DATATYPE	getTypedAttribute(String sName, 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.collections.attrs.IReadonlyAttributeContainer

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

Constructor Detail

AbstractReadonlyAttributeContainer

public AbstractReadonlyAttributeContainer()

Method Detail

getCastedAttribute

@Nullable
public final <DATATYPE> DATATYPE getCastedAttribute(@Nullable
                                              String sName)

Description copied from interface: IReadonlyAttributeContainer

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 IReadonlyAttributeContainer.getAttributeAsString(String)!
This call is identical to the call getCastedAttribute(sName, null)

Specified by:

getCastedAttribute in interface IReadonlyAttributeContainer

Type Parameters:

DATATYPE - return type

Parameters:

sName - the attribute name

Returns:

null if no such value exists

getCastedAttribute

@Nullable
public final <DATATYPE> DATATYPE getCastedAttribute(@Nullable
                                              String sName,
                                              @Nullable
                                              DATATYPE aDefault)

Description copied from interface: IReadonlyAttributeContainer

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

Specified by:

getCastedAttribute in interface IReadonlyAttributeContainer

Type Parameters:

DATATYPE - return type

Parameters:

sName - 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
                                             String sName,
                                             @Nonnull
                                             Class<DATATYPE> aDstClass)

Description copied from interface: IReadonlyAttributeContainer

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 IReadonlyAttributeContainer.getAttributeAsString(String)!
This call is identical to the call getTypedAttribute(sName, null)

Specified by:

getTypedAttribute in interface IReadonlyAttributeContainer

Type Parameters:

DATATYPE - return type

Parameters:

sName - 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
                                             String sName,
                                             @Nonnull
                                             Class<DATATYPE> aDstClass,
                                             @Nullable
                                             DATATYPE aDefault)

Description copied from interface: IReadonlyAttributeContainer

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

Specified by:

getTypedAttribute in interface IReadonlyAttributeContainer

Type Parameters:

DATATYPE - return type

Parameters:

sName - 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
                                   String sName)

Description copied from interface: IReadonlyAttributeContainer

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

Specified by:

getAttributeAsString in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAsString

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

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

Parameters:

sParamName - 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
                                   String sName,
                                   @Nullable
                                   String sDefault)

Description copied from interface: IReadonlyAttributeContainer

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 IReadonlyAttributeContainer

Parameters:

sName - 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
           String sParamName,
           @Nullable
           Object aValue,
           int nDefault)

getAttributeAsInt

public final int getAttributeAsInt(@Nullable
                    String sName)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsInt in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

Returns:

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

getAttributeAsInt

public final int getAttributeAsInt(@Nullable
                    String sName,
                    int nDefault)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsInt in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

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

Returns:

The attribute value or nDefault if no such attribute exists

getAsLong

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

getAttributeAsLong

public final long getAttributeAsLong(@Nullable
                      String sName)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsLong in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

Returns:

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

getAttributeAsLong

public final long getAttributeAsLong(@Nullable
                      String sName,
                      long nDefault)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsLong in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

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

Returns:

The attribute value or nDefault if no such attribute exists

getAsDouble

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

getAttributeAsDouble

public final double getAttributeAsDouble(@Nullable
                          String sName)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsDouble in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

Returns:

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

getAttributeAsDouble

public final double getAttributeAsDouble(@Nullable
                          String sName,
                          double dDefault)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsDouble in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

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

Returns:

The attribute value or nDefault if no such attribute exists

getAsBoolean

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

getAttributeAsBoolean

public final boolean getAttributeAsBoolean(@Nullable
                            String sName)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBoolean in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

Returns:

The attribute value or false if no such attribute exists

getAttributeAsBoolean

public final boolean getAttributeAsBoolean(@Nullable
                            String sName,
                            boolean bDefault)

Description copied from interface: IReadonlyAttributeContainer

Get the attribute value associated to the given attribute name.

Specified by:

getAttributeAsBoolean in interface IReadonlyAttributeContainer

Parameters:

sName - the attribute name

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

Returns:

The attribute value or bDefault if no such attribute exists