org.springframework.binding.collection
Class MapAccessor

java.lang.Object
  org.springframework.binding.collection.MapAccessor

All Implemented Interfaces:

MapAdaptable

public class MapAccessor
extends Object
implements MapAdaptable

A simple, generic decorator for getting attributes out of a map. May be instantiated directly or used as a base class as a convenience.

Author:

Keith Donald

Constructor Summary

MapAccessor(Map map)
Creates a new attribute map accessor.

Method Summary

Map	asMap() Returns this object's contents as a Map.
void	assertContainsKey(Object key) Asserts that the attribute is present in the attribute map.
Object	assertKeyValueInstanceOf(Object key, Object value, Class requiredType) Assert that the key value, if non null, is an instance of the required type.
Object	assertKeyValueOfType(Object key, Class requiredType) Assert that value of the map key, if non-null, is of the required type.
boolean	containsKey(Object key, Class requiredType) Indicates if the attribute is present in the attribute map and of the required type.
Object	get(Object key) Returns a value in the map, returning null if the attribute is not present.
Object	get(Object key, Class requiredType) Returns a value in the map, asserting it is of the required type if present and returning null if not found.
Object	get(Object key, Class requiredType, Object defaultValue) Returns a value in the map of the specified type, returning the defaultValue if no value is found.
Object	get(Object key, Object defaultValue) Returns a value in the map, returning the defaultValue if no value was found.
Object[]	getArray(Object key, Class requiredType) Returns a array value in the map, asserting it is of the required type if present and returning null if not found.
Boolean	getBoolean(Object key) Returns a boolean value in the map, returning null if no value was found.
Boolean	getBoolean(Object key, Boolean defaultValue) Returns a boolean value in the map, returning the defaultValue if no value was found.
Collection	getCollection(Object key) Returns a collection value in the map, returning null if no value was found.
Collection	getCollection(Object key, Class requiredType) Returns a collection value in the map, asserting it is of the required type if present and returning null if not found.
Integer	getInteger(Object key) Returns an integer value in the map, returning null if no value was found.
Integer	getInteger(Object key, Integer defaultValue) Returns an integer value in the map, returning the defaultValue if no value was found.
Long	getLong(Object key) Returns a long value in the map, returning null if no value was found.
Long	getLong(Object key, Long defaultValue) Returns a long value in the map, returning the defaultValue if no value was found.
Number	getNumber(Object key, Class requiredType) Returns a number value in the map that is of the specified type, returning null if no value was found.
Number	getNumber(Object key, Class requiredType, Number defaultValue) Returns a number attribute value in the map of the specified type, returning the defaultValue if no value was found.
Object	getRequired(Object key) Returns a value in the map, throwing an exception if the attribute is not present and of the correct type.
Object	getRequired(Object key, Class requiredType) Returns an value in the map, asserting it is present and of the required type.
Object[]	getRequiredArray(Object key, Class requiredType) Returns an array value in the map, asserting it is of the required type if present and throwing an exception if not found.
Boolean	getRequiredBoolean(Object key) Returns a boolean value in the map, throwing an exception if the value is not present and of the correct type.
Collection	getRequiredCollection(Object key) Returns a collection value in the map, throwing an exception if not found.
Collection	getRequiredCollection(Object key, Class requiredType) Returns a collection value in the map, asserting it is of the required type if present and throwing an exception if not found.
Integer	getRequiredInteger(Object key) Returns an integer value in the map, throwing an exception if the value is not present and of the correct type.
Long	getRequiredLong(Object key) Returns a long value in the map, throwing an exception if the value is not present and of the correct type.
Number	getRequiredNumber(Object key, Class requiredType) Returns a number value in the map, throwing an exception if the attribute is not present and of the correct type.
String	getRequiredString(Object key) Returns a string value in the map, throwing an exception if the attribute is not present and of the correct type.
String	getString(Object key) Returns a string value in the map, returning null if no value was found.
String	getString(Object key, String defaultValue) Returns a string value in the map, returning the defaultValue if no value was found.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapAccessor

public MapAccessor(Map map)

Creates a new attribute map accessor.

Parameters:

map - the map

Method Detail

asMap

public Map asMap()

Description copied from interface: MapAdaptable

Returns this object's contents as a Map. The returned map may or may not be modifiable depending on this implementation.

Warning: this operation may be called frequently; if so care should be taken so that the map contents (if calculated) be cached as appropriate.

Specified by:

asMap in interface MapAdaptable

Returns:

the object's contents as a map

get

public Object get(Object key)

Returns a value in the map, returning null if the attribute is not present.

Parameters:

key - the key

Returns:

the value

get

public Object get(Object key,
                  Object defaultValue)

Returns a value in the map, returning the defaultValue if no value was found.

Parameters:

key - the key

defaultValue - the default

Returns:

the attribute value

get

public Object get(Object key,
                  Class requiredType)
           throws IllegalArgumentException

Returns a value in the map, asserting it is of the required type if present and returning null if not found.

Parameters:

key - the key

requiredType - the required type

Returns:

the value

Throws:

IllegalArgumentException - if the key is present but the value is not of the required type

get

public Object get(Object key,
                  Class requiredType,
                  Object defaultValue)

Returns a value in the map of the specified type, returning the defaultValue if no value is found.

Parameters:

key - the key

requiredType - the required type

defaultValue - the default

Returns:

the attribute value

Throws:

IllegalArgumentException - if the key is present but the value is not of the required type

getRequired

public Object getRequired(Object key)
                   throws IllegalArgumentException

Returns a value in the map, throwing an exception if the attribute is not present and of the correct type.

Parameters:

key - the key

Returns:

the value

Throws:

IllegalArgumentException

getRequired

public Object getRequired(Object key,
                          Class requiredType)
                   throws IllegalArgumentException

Returns an value in the map, asserting it is present and of the required type.

Parameters:

key - the key

requiredType - the required type

Returns:

the value

Throws:

IllegalArgumentException

getString

public String getString(Object key)
                 throws IllegalArgumentException

Returns a string value in the map, returning null if no value was found.

Parameters:

key - the key

Returns:

the string value

Throws:

IllegalArgumentException - if the key is present but the value is not a string

getString

public String getString(Object key,
                        String defaultValue)
                 throws IllegalArgumentException

Returns a string value in the map, returning the defaultValue if no value was found.

Parameters:

key - the key

defaultValue - the default

Returns:

the string value

Throws:

IllegalArgumentException - if the key is present but the value is not a string

getRequiredString

public String getRequiredString(Object key)
                         throws IllegalArgumentException

Returns a string value in the map, throwing an exception if the attribute is not present and of the correct type.

Parameters:

key - the key

Returns:

the string value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a string

getCollection

public Collection getCollection(Object key)
                         throws IllegalArgumentException

Returns a collection value in the map, returning null if no value was found.

Parameters:

key - the key

Returns:

the collection value

Throws:

IllegalArgumentException - if the key is present but the value is not a collection

getCollection

public Collection getCollection(Object key,
                                Class requiredType)
                         throws IllegalArgumentException

Returns a collection value in the map, asserting it is of the required type if present and returning null if not found.

Parameters:

key - the key

Returns:

the collection value

Throws:

IllegalArgumentException - if the key is present but the value is not a collection

getRequiredCollection

public Collection getRequiredCollection(Object key)
                                 throws IllegalArgumentException

Returns a collection value in the map, throwing an exception if not found.

Parameters:

key - the key

Returns:

the collection value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a collection

getRequiredCollection

public Collection getRequiredCollection(Object key,
                                        Class requiredType)
                                 throws IllegalArgumentException

Returns a collection value in the map, asserting it is of the required type if present and throwing an exception if not found.

Parameters:

key - the key

Returns:

the collection value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a collection of the required type

getArray

public Object[] getArray(Object key,
                         Class requiredType)
                  throws IllegalArgumentException

Returns a array value in the map, asserting it is of the required type if present and returning null if not found.

Parameters:

key - the key

Returns:

the array value

Throws:

IllegalArgumentException - if the key is present but the value is not an array of the required type

getRequiredArray

public Object[] getRequiredArray(Object key,
                                 Class requiredType)
                          throws IllegalArgumentException

Returns an array value in the map, asserting it is of the required type if present and throwing an exception if not found.

Parameters:

key - the key

Returns:

the array value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a array of the required type

getNumber

public Number getNumber(Object key,
                        Class requiredType)
                 throws IllegalArgumentException

Returns a number value in the map that is of the specified type, returning null if no value was found.

Parameters:

key - the key

requiredType - the required number type

Returns:

the numbervalue

Throws:

IllegalArgumentException - if the key is present but the value is not a number of the required type

getNumber

public Number getNumber(Object key,
                        Class requiredType,
                        Number defaultValue)
                 throws IllegalArgumentException

Returns a number attribute value in the map of the specified type, returning the defaultValue if no value was found.

Parameters:

key - the attribute name

defaultValue - the default

Returns:

the number value

Throws:

IllegalArgumentException - if the key is present but the value is not a number of the required type

getRequiredNumber

public Number getRequiredNumber(Object key,
                                Class requiredType)
                         throws IllegalArgumentException

Returns a number value in the map, throwing an exception if the attribute is not present and of the correct type.

Parameters:

key - the key

Returns:

the number value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a number of the required type

getInteger

public Integer getInteger(Object key)
                   throws IllegalArgumentException

Returns an integer value in the map, returning null if no value was found.

Parameters:

key - the key

Returns:

the integer value

Throws:

IllegalArgumentException - if the key is present but the value is not an integer

getInteger

public Integer getInteger(Object key,
                          Integer defaultValue)
                   throws IllegalArgumentException

Returns an integer value in the map, returning the defaultValue if no value was found.

Parameters:

key - the key

defaultValue - the default

Returns:

the integer value

Throws:

IllegalArgumentException - if the key is present but the value is not an integer

getRequiredInteger

public Integer getRequiredInteger(Object key)
                           throws IllegalArgumentException

Returns an integer value in the map, throwing an exception if the value is not present and of the correct type.

Parameters:

key - the attribute name

Returns:

the integer attribute value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not an integer

getLong

public Long getLong(Object key)
             throws IllegalArgumentException

Returns a long value in the map, returning null if no value was found.

Parameters:

key - the key

Returns:

the long value

Throws:

IllegalArgumentException - if the key is present but not a long

getLong

public Long getLong(Object key,
                    Long defaultValue)
             throws IllegalArgumentException

Returns a long value in the map, returning the defaultValue if no value was found.

Parameters:

key - the key

defaultValue - the default

Returns:

the long attribute value

Throws:

IllegalArgumentException - if the key is present but the value is not a long

getRequiredLong

public Long getRequiredLong(Object key)
                     throws IllegalArgumentException

Returns a long value in the map, throwing an exception if the value is not present and of the correct type.

Parameters:

key - the key

Returns:

the long attribute value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a long

getBoolean

public Boolean getBoolean(Object key)
                   throws IllegalArgumentException

Returns a boolean value in the map, returning null if no value was found.

Parameters:

key - the key

Returns:

the boolean value

Throws:

IllegalArgumentException - if the key is present but the value is not a boolean

getBoolean

public Boolean getBoolean(Object key,
                          Boolean defaultValue)
                   throws IllegalArgumentException

Returns a boolean value in the map, returning the defaultValue if no value was found.

Parameters:

key - the key

defaultValue - the default

Returns:

the boolean value

Throws:

IllegalArgumentException - if the key is present but the value is not a boolean

getRequiredBoolean

public Boolean getRequiredBoolean(Object key)
                           throws IllegalArgumentException

Returns a boolean value in the map, throwing an exception if the value is not present and of the correct type.

Parameters:

key - the attribute

Returns:

the boolean value

Throws:

IllegalArgumentException - if the key is not present or present but the value is not a boolean

assertContainsKey

public void assertContainsKey(Object key)
                       throws IllegalArgumentException

Asserts that the attribute is present in the attribute map.

Parameters:

key - the key

Throws:

IllegalArgumentException - if the key is not present

containsKey

public boolean containsKey(Object key,
                           Class requiredType)
                    throws IllegalArgumentException

Indicates if the attribute is present in the attribute map and of the required type.

Parameters:

key - the attribute name

Returns:

true if present and of the required type, false if not present.

Throws:

IllegalArgumentException

assertKeyValueOfType

public Object assertKeyValueOfType(Object key,
                                   Class requiredType)

Assert that value of the map key, if non-null, is of the required type.

Parameters:

key - the attribute name

requiredType - the required attribute value type

Returns:

the attribute value

assertKeyValueInstanceOf

public Object assertKeyValueInstanceOf(Object key,
                                       Object value,
                                       Class requiredType)

Assert that the key value, if non null, is an instance of the required type.

Parameters:

key - the key

value - the value

requiredType - the required type

Returns:

the value