@Target(value=PARAMETER) @Retention(value=RUNTIME) @Documented public @interface MatrixVariable
RequestMapping
annotated handler methods in Servlet environments.
If the method parameter type is Map
and a matrix variable
name is specified, then the matrix variable value is converted to a
Map
assuming an appropriate conversion strategy is available.
If the method parameter is Map<String, String>
or
MultiValueMap<String, String>
and a variable name is not specified, then the map is populated with all
matrix variable names and values.
Modifier and Type | Optional Element and Description |
---|---|
String |
defaultValue
The default value to use as a fallback.
|
String |
name
The name of the matrix variable.
|
String |
pathVar
The name of the URI path variable where the matrix variable is located,
if necessary for disambiguation (e.g.
|
boolean |
required
Whether the matrix variable is required.
|
String |
value
Alias for
name() . |
public abstract String pathVar
public abstract boolean required
Default is true
, leading to an exception being thrown in
case the variable is missing in the request. Switch this to false
if you prefer a null
if the variable is missing.
Alternatively, provide a defaultValue()
, which implicitly sets
this flag to false
.
public abstract String defaultValue
Supplying a default value implicitly sets required()
to
false
.