LocalParameterMap

java.lang.Object
- org.springframework.webflow.core.collection.LocalParameterMap

All Implemented Interfaces:

Serializable, MapAdaptable, 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:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`LocalParameterMap(Map parameters)` Creates a new parameter map from the provided map.
`LocalParameterMap(Map parameters, ConversionService conversionService)` Creates a new parameter map from the provided map.

Method Summary

Methods
Modifier and Type	Method and Description
`AttributeMap`	`asAttributeMap()` Adapts this parameter map to an `AttributeMap`.
`Map`	`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.
`Object`	`get(String parameterName, Class targetType)` Get a parameter value, converting it from `String` to the target type.
`Object`	`get(String parameterName, Class targetType, Object 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.
`Object[]`	`getArray(String parameterName, Class 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.
`org.springframework.web.multipart.MultipartFile`	`getMultipartFile(String parameterName)` Get a multi-part file parameter value, returning `null` if no value is found.
`Number`	`getNumber(String parameterName, Class targetType)` Returns a number parameter value in the map that is of the specified type, returning `null` if no value was found.
`Number`	`getNumber(String parameterName, Class targetType, Number 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.
`Object`	`getRequired(String parameterName, Class 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.
`Object[]`	`getRequiredArray(String parameterName, Class 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.
`Number`	`getRequiredNumber(String parameterName, Class 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()`
`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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LocalParameterMap
```
public LocalParameterMap(Map 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 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 Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ParameterMap
    
    Is this parameter map empty, with a size of 0?
    
    Specified by:
    
    isEmpty in interface ParameterMap
    
    Returns:
    true if empty, false if not
  - size
```
public int size()
```
    Description copied from interface: ParameterMap
    
    Returns the number of parameters in this map.
    
    Specified by:
    
    size in interface ParameterMap
    
    Returns:
    the parameter count
  - contains
```
public boolean contains(String parameterName)
```
    Description copied from interface: ParameterMap
    
    Does the parameter with the provided name exist in this map?
    
    Specified by:
    
    contains in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    true if so, false otherwise
  - get
```
public String get(String parameterName)
```
    Description copied from interface: ParameterMap
    
    Get a parameter value, returning null if no value is found.
    
    Specified by:
    
    get in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the parameter value
  - get
```
public String get(String parameterName,
         String defaultValue)
```
    Description copied from interface: ParameterMap
    
    Get a parameter value, returning the defaultValue if no value is found.
    
    Specified by:
    
    get in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    defaultValue - the default
    
    Returns:
    the parameter value
  - getArray
```
public String[] getArray(String parameterName)
```
    Description copied from interface: ParameterMap
    
    Get a multi-valued parameter value, returning null if no value is found. If the parameter is single valued an array with a single element is returned.
    
    Specified by:
    
    getArray in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the parameter value array
  - getArray
```
public Object[] getArray(String parameterName,
                Class targetElementType)
                  throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Get a multi-valued parameter value, converting each value to the target type or returning null if no value is found.
    
    Specified by:
    
    getArray in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    targetElementType - the target type of the array's elements
    
    Returns:
    the converterd parameter value array
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - get
```
public Object get(String parameterName,
         Class targetType)
           throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Get a parameter value, converting it from String to the target type.
    
    Specified by:
    
    get in interface ParameterMap
    
    Parameters:
    parameterName - the name of the parameter
    targetType - the target type of the parameter value
    
    Returns:
    the converted parameter value, or null if not found
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - get
```
public Object get(String parameterName,
         Class targetType,
         Object defaultValue)
           throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Get a parameter value, converting it from String to the target type or returning the defaultValue if not found.
    
    Specified by:
    
    get in interface ParameterMap
    
    Parameters:
    parameterName - name of the parameter to get
    targetType - the target type of the parameter value
    defaultValue - the default value
    
    Returns:
    the converted parameter value, or the default if not found
    
    Throws:
    
    ConversionExecutionException - when a value could not be converted
  - getRequired
```
public String getRequired(String parameterName)
                   throws IllegalArgumentException
```
    Description copied from interface: ParameterMap
    
    Get the value of a required parameter.
    
    Specified by:
    
    getRequired in interface ParameterMap
    
    Parameters:
    parameterName - the name of the parameter
    
    Returns:
    the parameter value
    
    Throws:
    
    IllegalArgumentException - when the parameter is not found
  - getRequiredArray
```
public String[] getRequiredArray(String parameterName)
                          throws IllegalArgumentException
```
    Description copied from interface: ParameterMap
    
    Get a required multi-valued parameter value.
    
    Specified by:
    
    getRequiredArray in interface ParameterMap
    
    Parameters:
    parameterName - the name of the parameter
    
    Returns:
    the parameter value
    
    Throws:
    
    IllegalArgumentException - when the parameter is not found
  - getRequiredArray
```
public Object[] getRequiredArray(String parameterName,
                        Class targetElementType)
                          throws IllegalArgumentException,
                                 ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Get a required multi-valued parameter value, converting each value to the target type.
    
    Specified by:
    
    getRequiredArray in interface ParameterMap
    
    Parameters:
    parameterName - the name of the parameter
    
    Returns:
    the parameter value
    
    Throws:
    
    IllegalArgumentException - when the parameter is not found
    
    ConversionExecutionException - when a value could not be converted
  - getRequired
```
public Object getRequired(String parameterName,
                 Class targetType)
                   throws IllegalArgumentException,
                          ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Get the value of a required parameter and convert it to the target type.
    
    Specified by:
    
    getRequired in interface ParameterMap
    
    Parameters:
    parameterName - the name of the parameter
    targetType - the target type of the parameter value
    
    Returns:
    the converted parameter value
    
    Throws:
    
    IllegalArgumentException - when the parameter is not found
    
    ConversionExecutionException - when the value could not be converted
  - getNumber
```
public Number getNumber(String parameterName,
               Class targetType)
                 throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a number parameter value in the map that is of the specified type, returning null if no value was found.
    
    Specified by:
    
    getNumber in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    targetType - the target number type
    
    Returns:
    the number parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getNumber
```
public Number getNumber(String parameterName,
               Class targetType,
               Number defaultValue)
                 throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a number parameter value in the map of the specified type, returning the defaultValue if no value was found.
    
    Specified by:
    
    getNumber in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    defaultValue - the default
    
    Returns:
    the number parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getRequiredNumber
```
public Number getRequiredNumber(String parameterName,
                       Class targetType)
                         throws IllegalArgumentException,
                                ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a number parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    
    Specified by:
    
    getRequiredNumber in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the number parameter value
    
    Throws:
    
    IllegalArgumentException - if the parameter is not present
    
    ConversionExecutionException - when the value could not be converted
  - getInteger
```
public Integer getInteger(String parameterName)
                   throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns an integer parameter value in the map, returning null if no value was found.
    
    Specified by:
    
    getInteger in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the integer parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getInteger
```
public Integer getInteger(String parameterName,
                 Integer defaultValue)
                   throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns an integer parameter value in the map, returning the defaultValue if no value was found.
    
    Specified by:
    
    getInteger in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    defaultValue - the default
    
    Returns:
    the integer parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getRequiredInteger
```
public Integer getRequiredInteger(String parameterName)
                           throws IllegalArgumentException,
                                  ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns an integer parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    
    Specified by:
    
    getRequiredInteger in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the integer parameter value
    
    Throws:
    
    IllegalArgumentException - if the parameter is not present
    
    ConversionExecutionException - when the value could not be converted
  - getLong
```
public Long getLong(String parameterName)
             throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a long parameter value in the map, returning null if no value was found.
    
    Specified by:
    
    getLong in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the long parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getLong
```
public Long getLong(String parameterName,
           Long defaultValue)
             throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a long parameter value in the map, returning the defaultValue if no value was found.
    
    Specified by:
    
    getLong in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    defaultValue - the default
    
    Returns:
    the long parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getRequiredLong
```
public Long getRequiredLong(String parameterName)
                     throws IllegalArgumentException,
                            ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a long parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    
    Specified by:
    
    getRequiredLong in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the long parameter value
    
    Throws:
    
    IllegalArgumentException - if the parameter is not present
    
    ConversionExecutionException - when the value could not be converted
  - getBoolean
```
public Boolean getBoolean(String parameterName)
                   throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a boolean parameter value in the map, returning null if no value was found.
    
    Specified by:
    
    getBoolean in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the long parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getBoolean
```
public Boolean getBoolean(String parameterName,
                 Boolean defaultValue)
                   throws ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a boolean parameter value in the map, returning the defaultValue if no value was found.
    
    Specified by:
    
    getBoolean in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    defaultValue - the default
    
    Returns:
    the boolean parameter value
    
    Throws:
    
    ConversionExecutionException - when the value could not be converted
  - getRequiredBoolean
```
public Boolean getRequiredBoolean(String parameterName)
                           throws IllegalArgumentException,
                                  ConversionExecutionException
```
    Description copied from interface: ParameterMap
    
    Returns a boolean parameter value in the map, throwing an exception if the parameter is not present or could not be converted.
    
    Specified by:
    
    getRequiredBoolean in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the boolean parameter value
    
    Throws:
    
    IllegalArgumentException - if the parameter is not present
    
    ConversionExecutionException - when the value could not be converted
  - getMultipartFile
```
public org.springframework.web.multipart.MultipartFile getMultipartFile(String parameterName)
```
    Description copied from interface: ParameterMap
    
    Get a multi-part file parameter value, returning null if no value is found.
    
    Specified by:
    
    getMultipartFile in interface ParameterMap
    
    Parameters:
    parameterName - the parameter name
    
    Returns:
    the multipart file
  - getRequiredMultipartFile
```
public org.springframework.web.multipart.MultipartFile getRequiredMultipartFile(String parameterName)
                                                                         throws IllegalArgumentException
```
    Description copied from interface: ParameterMap
    
    Get the value of a required multipart file parameter.
    
    Specified by:
    
    getRequiredMultipartFile in interface ParameterMap
    
    Parameters:
    parameterName - the name of the parameter
    
    Returns:
    the parameter value
    
    Throws:
    
    IllegalArgumentException - when the parameter is not found
  - asAttributeMap
```
public AttributeMap asAttributeMap()
```
    Description copied from interface: ParameterMap
    
    Adapts this parameter map to an AttributeMap.
    
    Specified by:
    
    asAttributeMap in interface ParameterMap
    
    Returns:
    the underlying map as a unmodifiable attribute map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LocalParameterMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocalParameterMap

LocalParameterMap

Method Detail

equals

hashCode

asMap

isEmpty

size

contains

get

get

getArray

getArray

get

get

getRequired

getRequiredArray

getRequiredArray

getRequired

getNumber

getNumber

getRequiredNumber

getInteger

getInteger

getRequiredInteger

getLong

getLong

getRequiredLong

getBoolean

getBoolean

getRequiredBoolean

getMultipartFile

getRequiredMultipartFile

asAttributeMap

toString