org.springframework.webflow.core.collection
Interface ParameterMap

All Superinterfaces:

MapAdaptable

All Known Implementing Classes:

LocalParameterMap, MockParameterMap

public interface ParameterMap
extends MapAdaptable

An interface for accessing parameters in a backing map. Parameters are immutable and have string keys and string values.

The accessor methods offered by this class taking a target type argument only need to support conversions to well know types like String, Number subclasses, Boolean and so on.

Author:

Keith Donald

Method Summary

AttributeMap	asAttributeMap() Adapts this parameter map to an AttributeMap.
boolean	contains(String parameterName) Does the parameter with the provided name exist in this map?
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.
boolean	isEmpty() Is this parameter map empty, with a size of 0?
int	size() Returns the number of parameters in this map.

Methods inherited from interface org.springframework.binding.collection.MapAdaptable

asMap

Method Detail

isEmpty

boolean isEmpty()

Is this parameter map empty, with a size of 0?

Returns:

true if empty, false if not

size

int size()

Returns the number of parameters in this map.

Returns:

the parameter count

contains

boolean contains(String parameterName)

Does the parameter with the provided name exist in this map?

Parameters:

parameterName - the parameter name

Returns:

true if so, false otherwise

get

String get(String parameterName)

Get a parameter value, returning null if no value is found.

Parameters:

parameterName - the parameter name

Returns:

the parameter value

get

String get(String parameterName,
           String defaultValue)

Get a parameter value, returning the defaultValue if no value is found.

Parameters:

parameterName - the parameter name

defaultValue - the default

Returns:

the parameter value

getArray

String[] getArray(String parameterName)

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.

Parameters:

parameterName - the parameter name

Returns:

the parameter value array

getArray

Object[] getArray(String parameterName,
                  Class targetElementType)
                  throws ConversionExecutionException

Get a multi-valued parameter value, converting each value to the target type or returning null if no value is found.

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

Object get(String parameterName,
           Class targetType)
           throws ConversionExecutionException

Get a parameter value, converting it from String to the target type.

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

Object get(String parameterName,
           Class targetType,
           Object defaultValue)
           throws ConversionExecutionException

Get a parameter value, converting it from String to the target type or returning the defaultValue if not found.

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

String getRequired(String parameterName)
                   throws IllegalArgumentException

Get the value of a required parameter.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value

Throws:

IllegalArgumentException - when the parameter is not found

getRequiredArray

String[] getRequiredArray(String parameterName)
                          throws IllegalArgumentException

Get a required multi-valued parameter value.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value

Throws:

IllegalArgumentException - when the parameter is not found

getRequiredArray

Object[] getRequiredArray(String parameterName,
                          Class targetElementType)
                          throws IllegalArgumentException,
                                 ConversionExecutionException

Get a required multi-valued parameter value, converting each value to the target type.

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

Object getRequired(String parameterName,
                   Class targetType)
                   throws IllegalArgumentException,
                          ConversionExecutionException

Get the value of a required parameter and convert it to the target type.

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

Number getNumber(String parameterName,
                 Class targetType)
                 throws ConversionExecutionException

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

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

Number getNumber(String parameterName,
                 Class targetType,
                 Number defaultValue)
                 throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

defaultValue - the default

Returns:

the number parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getRequiredNumber

Number getRequiredNumber(String parameterName,
                         Class targetType)
                         throws IllegalArgumentException,
                                ConversionExecutionException

Returns a number parameter value in the map, throwing an exception if the parameter is not present or could not be converted.

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

Integer getInteger(String parameterName)
                   throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

Returns:

the integer parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getInteger

Integer getInteger(String parameterName,
                   Integer defaultValue)
                   throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

defaultValue - the default

Returns:

the integer parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getRequiredInteger

Integer getRequiredInteger(String parameterName)
                           throws IllegalArgumentException,
                                  ConversionExecutionException

Returns an integer parameter value in the map, throwing an exception if the parameter is not present or could not be converted.

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

Long getLong(String parameterName)
             throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

Returns:

the long parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getLong

Long getLong(String parameterName,
             Long defaultValue)
             throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

defaultValue - the default

Returns:

the long parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getRequiredLong

Long getRequiredLong(String parameterName)
                     throws IllegalArgumentException,
                            ConversionExecutionException

Returns a long parameter value in the map, throwing an exception if the parameter is not present or could not be converted.

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

Boolean getBoolean(String parameterName)
                   throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

Returns:

the long parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getBoolean

Boolean getBoolean(String parameterName,
                   Boolean defaultValue)
                   throws ConversionExecutionException

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

Parameters:

parameterName - the parameter name

defaultValue - the default

Returns:

the boolean parameter value

Throws:

ConversionExecutionException - when the value could not be converted

getRequiredBoolean

Boolean getRequiredBoolean(String parameterName)
                           throws IllegalArgumentException,
                                  ConversionExecutionException

Returns a boolean parameter value in the map, throwing an exception if the parameter is not present or could not be converted.

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

org.springframework.web.multipart.MultipartFile getMultipartFile(String parameterName)

Get a multi-part file parameter value, returning null if no value is found.

Parameters:

parameterName - the parameter name

Returns:

the multipart file

getRequiredMultipartFile

org.springframework.web.multipart.MultipartFile getRequiredMultipartFile(String parameterName)

Get the value of a required multipart file parameter.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value

Throws:

IllegalArgumentException - when the parameter is not found

asAttributeMap

AttributeMap asAttributeMap()

Adapts this parameter map to an AttributeMap.

Returns:

the underlying map as a unmodifiable attribute map