com.helger.commons.collections.attrs

Interface IReadonlyAttributeContainer

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAttributeContainer

All Known Implementing Classes:

AbstractReadonlyAttributeContainer, MapBasedAttributeContainer, MapBasedAttributeContainerThreadSafe, MapBasedReadonlyAttributeContainer

public interface IReadonlyAttributeContainer
extends Serializable

Base interface for a generic read-only attribute container. It maps strings to any Java object.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	containsAttribute(String sName) Check if an attribute of the given name is contained.
boolean	containsNoAttribute()
Set<String>	getAllAttributeNames()
Map<String,Object>	getAllAttributes()
Collection<Object>	getAllAttributeValues()
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.
int	getAttributeCount()
Enumeration<String>	getAttributeNames() Get an enumerator over all contained attribute names.
Object	getAttributeObject(String sName) Get the attribute value associated to the given attribute name.
<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.

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

Check if an attribute of the given name is contained.

Parameters:

sName - name of the attribute to check

Returns:

true if the attribute is contained, false otherwise

getAllAttributes

@Nonnull
 @ReturnsMutableCopy
Map<String,Object> getAllAttributes()

Returns:

The non-null map with all contained attributes.

getAttributeObject

@Nullable
Object getAttributeObject(@Nullable
                                     String sName)

Get the attribute value associated to the given attribute name.

Parameters:

sName - the attribute name

Returns:

null if no such value exists

getCastedAttribute

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

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

Type Parameters:

DATATYPE - return type

Parameters:

sName - the attribute name

Returns:

null if no such value exists

getCastedAttribute

@Nullable
<DATATYPE> DATATYPE getCastedAttribute(@Nullable
                                                  String sName,
                                                  @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(String, String)!

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
<DATATYPE> DATATYPE getTypedAttribute(@Nullable
                                                 String sName,
                                                 @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(String)!
This call is identical to the call getTypedAttribute(sName, null)

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
<DATATYPE> DATATYPE getTypedAttribute(@Nullable
                                                 String sName,
                                                 @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(String, String)!

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
String getAttributeAsString(@Nullable
                                       String sName)

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

Parameters:

sName - the attribute name

Returns:

The attribute value or null if no such attribute exists

getAttributeAsString

@Nullable
String getAttributeAsString(@Nullable
                                       String sName,
                                       @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:

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

getAttributeAsInt

int getAttributeAsInt(@Nullable
                      String sName)

Get the attribute value associated to the given attribute name.

Parameters:

sName - the attribute name

Returns:

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

getAttributeAsInt

int getAttributeAsInt(@Nullable
                      String sName,
                      int nDefault)

Get the attribute value associated to the given attribute name.

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

getAttributeAsLong

long getAttributeAsLong(@Nullable
                        String sName)

Get the attribute value associated to the given attribute name.

Parameters:

sName - the attribute name

Returns:

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

getAttributeAsLong

long getAttributeAsLong(@Nullable
                        String sName,
                        long nDefault)

Get the attribute value associated to the given attribute name.

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

getAttributeAsDouble

double getAttributeAsDouble(@Nullable
                            String sName)

Get the attribute value associated to the given attribute name.

Parameters:

sName - the attribute name

Returns:

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

getAttributeAsDouble

double getAttributeAsDouble(@Nullable
                            String sName,
                            double dDefault)

Get the attribute value associated to the given attribute name.

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

getAttributeAsBoolean

boolean getAttributeAsBoolean(@Nullable
                              String sName)

Get the attribute value associated to the given attribute name.

Parameters:

sName - the attribute name

Returns:

The attribute value or false if no such attribute exists

getAttributeAsBoolean

boolean getAttributeAsBoolean(@Nullable
                              String sName,
                              boolean bDefault)

Get the attribute value associated to the given attribute name.

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

getAttributeNames

@Nonnull
Enumeration<String> getAttributeNames()

Get an enumerator over all contained attribute names.

Returns:

an Enumerator over all attribute names

getAllAttributeNames

@Nonnull
Set<String> getAllAttributeNames()

Returns:

A non-null set of all attribute names.

getAllAttributeValues

@Nonnull
Collection<Object> getAllAttributeValues()

Returns:

A non-null collection of all attribute values.