Package org.springframework.webflow.core.collection

Class LocalParameterMap

java.lang.Object
org.springframework.webflow.core.collection.LocalParameterMap
All Implemented Interfaces:
Serializable, MapAdaptable<String,Object>, ParameterMap
Direct Known Subclasses:
MockParameterMap
public class LocalParameterMap extends Object implements ParameterMap, Serializable
An immutable parameter map storing String-keyed, String-valued parameters in a backing Map implementation. This base provides convenient operations for accessing parameters in a typed-manner.
Author:
Keith Donald
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    LocalParameterMap(Map<String,Object> parameters)
    Creates a new parameter map from the provided map.
    LocalParameterMap(Map<String,Object> parameters, ConversionService conversionService)
    Creates a new parameter map from the provided map.

  • Method Summary

    Modifier and Type
    Method
    Description
    AttributeMap<Object>
    asAttributeMap()
    Adapts this parameter map to an AttributeMap.
    Map<String,Object>
    asMap()
    Returns this object's contents as a Map.
    boolean
    contains(String parameterName)
    Does the parameter with the provided name exist in this map?
    boolean
    equals(Object o)
     
    String
    get(String parameterName)
    Get a parameter value, returning null if no value is found.
    <T> T
    get(String parameterName, Class<T> targetType)
    Get a parameter value, converting it from String to the target type.
    <T> T
    get(String parameterName, Class<T> targetType, T defaultValue)
    Get a parameter value, converting it from String to the target type or returning the defaultValue if not found.
    String
    get(String parameterName, String defaultValue)
    Get a parameter value, returning the defaultValue if no value is found.
    String[]
    getArray(String parameterName)
    Get a multi-valued parameter value, returning null if no value is found.
    <T> T[]
    getArray(String parameterName, Class<T> targetElementType)
    Get a multi-valued parameter value, converting each value to the target type or returning null if no value is found.
    Boolean
    getBoolean(String parameterName)
    Returns a boolean parameter value in the map, returning null if no value was found.
    Boolean
    getBoolean(String parameterName, Boolean defaultValue)
    Returns a boolean parameter value in the map, returning the defaultValue if no value was found.
    Integer
    getInteger(String parameterName)
    Returns an integer parameter value in the map, returning null if no value was found.
    Integer
    getInteger(String parameterName, Integer defaultValue)
    Returns an integer parameter value in the map, returning the defaultValue if no value was found.
    Long
    getLong(String parameterName)
    Returns a long parameter value in the map, returning null if no value was found.
    Long
    getLong(String parameterName, Long defaultValue)
    Returns a long parameter value in the map, returning the defaultValue if no value was found.
    protected Map<String,Object>
    getMapInternal()
    Returns the wrapped, modifiable map implementation.
    org.springframework.web.multipart.MultipartFile
    getMultipartFile(String parameterName)
    Get a multi-part file parameter value, returning null if no value is found.
    <T extends Number>
    T
    getNumber(String parameterName, Class<T> targetType)
    Returns a number parameter value in the map that is of the specified type, returning null if no value was found.
    <T extends Number>
    T
    getNumber(String parameterName, Class<T> targetType, T defaultValue)
    Returns a number parameter value in the map of the specified type, returning the defaultValue if no value was found.
    String
    getRequired(String parameterName)
    Get the value of a required parameter.
    <T> T
    getRequired(String parameterName, Class<T> targetType)
    Get the value of a required parameter and convert it to the target type.
    String[]
    getRequiredArray(String parameterName)
    Get a required multi-valued parameter value.
    <T> T[]
    getRequiredArray(String parameterName, Class<T> targetElementType)
    Get a required multi-valued parameter value, converting each value to the target type.
    Boolean
    getRequiredBoolean(String parameterName)
    Returns a boolean parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    Integer
    getRequiredInteger(String parameterName)
    Returns an integer parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    Long
    getRequiredLong(String parameterName)
    Returns a long parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    org.springframework.web.multipart.MultipartFile
    getRequiredMultipartFile(String parameterName)
    Get the value of a required multipart file parameter.
    <T extends Number>
    T
    getRequiredNumber(String parameterName, Class<T> targetType)
    Returns a number parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    int
    hashCode()
     
    protected void
    initParameters(Map<String,Object> parameters)
    Initializes this parameter map.
    boolean
    isEmpty()
    Is this parameter map empty, with a size of 0?
    int
    size()
    Returns the number of parameters in this map.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LocalParameterMap

      public LocalParameterMap(Map<String,Object> parameters)
      Creates a new parameter map from the provided map.

      It is expected that the contents of the backing map adhere to the parameter map contract; that is, map entries have string keys, string values, and remain unmodifiable.

      Parameters:
      parameters - the contents of this parameter map

    • LocalParameterMap

      public LocalParameterMap(Map<String,Object> parameters, ConversionService conversionService)
      Creates a new parameter map from the provided map.

      It is expected that the contents of the backing map adhere to the parameter map contract; that is, map entries have string keys, string values, and remain unmodifiable.

      Parameters:
      parameters - the contents of this parameter map
      conversionService - a helper for performing type conversion of map entry values

  • Method Details