Package org.springframework.binding.collection

Class MapAccessor<K,V>

java.lang.Object
org.springframework.binding.collection.MapAccessor<K,V>
All Implemented Interfaces:
MapAdaptable<K,V>
public class MapAccessor<K,V> extends Object implements MapAdaptable<K,V>
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

    Constructors
    Constructor
    Description
    MapAccessor(Map<K,V> map)
    Creates a new attribute map accessor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<K,V>
    asMap()
    Returns this object's contents as a Map.
    void
    assertContainsKey(Object key)
    Asserts that the attribute is present in the attribute map.
    <T> T
    assertKeyValueInstanceOf(Object key, Object value, Class<T> requiredType)
    Assert that the key value, if non null, is an instance of the required type.
    <T> T
    assertKeyValueOfType(Object key, Class<T> 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.
    V
    get(Object key)
    Returns a value in the map, returning null if the attribute is not present.
    <T extends V>
    T
    get(Object key, Class<T> requiredType)
    Returns a value in the map, asserting it is of the required type if present and returning null if not found.
    <T extends V>
    T
    get(Object key, Class<T> requiredType, T defaultValue)
    Returns a value in the map of the specified type, returning the defaultValue if no value is found.
    V
    get(Object key, V defaultValue)
    Returns a value in the map, returning the defaultValue if no value was found.
    <T extends V>
    T[]
    getArray(Object key, Class<? extends T[]> 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<V>
    getCollection(Object key)
    Returns a collection value in the map, returning null if no value was found.
    <T extends Collection<V>>
    T
    getCollection(Object key, Class<T> 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.
    <T extends Number>
    T
    getNumber(Object key, Class<T> requiredType)
    Returns a number value in the map that is of the specified type, returning null if no value was found.
    <T extends Number>
    T
    getNumber(Object key, Class<T> requiredType, T defaultValue)
    Returns a number attribute value in the map of the specified type, returning the defaultValue if no value was found.
    V
    getRequired(Object key)
    Returns a value in the map, throwing an exception if the attribute is not present and of the correct type.
    <T extends V>
    T
    getRequired(Object key, Class<T> requiredType)
    Returns an value in the map, asserting it is present and of the required type.
    <T extends V>
    T[]
    getRequiredArray(Object key, Class<? extends T[]> 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<V>
    getRequiredCollection(Object key)
    Returns a collection value in the map, throwing an exception if not found.
    <T extends Collection<V>>
    T
    getRequiredCollection(Object key, Class<T> 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.
    <T extends Number>
    T
    getRequiredNumber(Object key, Class<T> 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

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

  • Constructor Details

    • MapAccessor

      public MapAccessor(Map<K,V> map)
      Creates a new attribute map accessor.
      Parameters:
      map - the map

  • Method Details

    • asMap

      public Map<K,V> 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<K,V>
      Returns:
      the object's contents as a map

    • get

      public V 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 V get(Object key, V 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 <T extends V> T get(Object key, Class<T> 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 <T extends V> T get(Object key, Class<T> requiredType, T 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 V 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 <T extends V> T getRequired(Object key, Class<T> 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<V> 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 <T extends Collection<V>> T getCollection(Object key, Class<T> 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<V> 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 <T extends Collection<V>> T getRequiredCollection(Object key, Class<T> 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 <T extends V> T[] getArray(Object key, Class<? extends T[]> 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 <T extends V> T[] getRequiredArray(Object key, Class<? extends T[]> 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 <T extends Number> T getNumber(Object key, Class<T> 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 number value
      Throws:
      IllegalArgumentException - if the key is present but the value is not a number of the required type

    • getNumber

      public <T extends Number> T getNumber(Object key, Class<T> requiredType, T 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 <T extends Number> T getRequiredNumber(Object key, Class<T> 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 <T> T assertKeyValueOfType(Object key, Class<T> 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 <T> T assertKeyValueInstanceOf(Object key, Object value, Class<T> 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