org.gatein.api.common

Class Attributes

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,String>

org.gatein.api.common.Attributes

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String>

public class Attributes
extends HashMap<String,String>
implements Serializable

Implements Map and adds convinience methods to retrieve a String property converted into a specific type. The get(Key), put(Key, Object) and remove(Key) methods converts String values to/from the instances of the class specified by Attributes.Key.type.

Author:

Nick Scavelli, Stian Thorgersen

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attributes.Key<T>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
Attributes() Creates a new attributes instance with no attributes
Attributes(Map<String,String> values) Creates a new attributes instance and adds all attributes from the specified map

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(Attributes.Key<T> key) Returns the value to the which the specified key name is mapped.
static <T> Attributes.Key<T>	key(String name, Class<T> type) Creates a key with the specified name and type.
<T> T	put(Attributes.Key<T> key, T value) Converts the value into a String using the toString method
<T> T	remove(Attributes.Key<T> key) Removes the attribute that is mapped to the specified key name

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

Attributes

public Attributes()

Creates a new attributes instance with no attributes

Attributes

public Attributes(Map<String,String> values)

Creates a new attributes instance and adds all attributes from the specified map

Parameters:

values - the map of attributes to add

Method Detail

get

public <T> T get(Attributes.Key<T> key)

Returns the value to the which the specified key name is mapped. The value is returned as the type specified by the key type

Parameters:

key - the key for the attribute

Returns:

the converted value

Throws:

IllegalArgumentException - if the specified key is null, or the value failed to convert into to key type

put

public <T> T put(Attributes.Key<T> key,
        T value)

Converts the value into a String using the toString method

Parameters:

key - the key for the attribute

value - the value

Returns:

the previous value, or null if it didn't exist

Throws:

IllegalArgumentException - if the specified key is null, the current value is non-null and failed to convert into the key type, or the value class is not the same as the key type

remove

public <T> T remove(Attributes.Key<T> key)

Removes the attribute that is mapped to the specified key name

Parameters:

key - the key for the the attribute

Returns:

the previous value, or null if it didn't exist

Throws:

IllegalArgumentException - if the specified key is null, or the current value is non-null and failed to to convert into the key type

key

public static <T> Attributes.Key<T> key(String name,
                        Class<T> type)

Creates a key with the specified name and type. The type class has to either be String or implement a static method valueOf(String) method as specified in get(Key). The valueOf method should convert the string parameter into an instance of type and return it.

Parameters:

name - the key name

type - the key type

Returns:

the key

Throws:

IllegalArgumentException - if name or type is null, or if type is not String or does not implement the static valueOf method