Annotation Type MatrixVariable
@Target(PARAMETER) @Retention(RUNTIME) @Documented public @interface MatrixVariable
Annotation which indicates that a method parameter should be bound to a name-value pair within a path segment. Supported forRequestMappingannotated handler methods in Servlet environments.If the method parameter type is
Mapand a matrix variable name is specified, then the matrix variable value is converted to aMapassuming an appropriate conversion strategy is available.If the method parameter is
Map<String, String>orMultiValueMap<String, String>and a variable name is not specified, then the map is populated with all matrix variable names and values.- Since:
- 3.2
- Author:
- Rossen Stoyanchev, Sam Brannen
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringdefaultValueThe default value to use as a fallback.StringnameThe name of the matrix variable.StringpathVarThe name of the URI path variable where the matrix variable is located, if necessary for disambiguation (e.g.booleanrequiredWhether the matrix variable is required.StringvalueAlias forname().
required
boolean required
Whether the matrix variable is required.Default is
true, leading to an exception being thrown in case the variable is missing in the request. Switch this tofalseif you prefer anullif the variable is missing.Alternatively, provide a
defaultValue(), which implicitly sets this flag tofalse.- Default:
- true
defaultValue
String defaultValue
The default value to use as a fallback.Supplying a default value implicitly sets
required()tofalse.- Default:
- "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"