Annotation Type MatrixParam
@Target({PARAMETER,METHOD,FIELD}) @Retention(RUNTIME) @Documented public @interface MatrixParam
Encoded
annotation. A default value
can be specified using the DefaultValue
annotation.
Note that the @MatrixParam
annotation value
refers to a name of a matrix parameter that
resides in the last matched path segment of the Path
-annotated Java structure that injects the value of the
matrix parameter.
The type T
of the annotated parameter, field or property must either:
- Be a primitive type
- Have a constructor that accepts a single
String
argument - Have a static method named
valueOf
orfromString
that accepts a singleString
argument (see, for example,Integer.valueOf(String)
) - Have a registered implementation of
ParamConverterProvider
JAX-RS extension SPI that returns aParamConverter
instance capable of a "from string" conversion for the type. - Be
List<T>
,Set<T>
orSortedSet<T>
, whereT
satisfies 2, 3 or 4 above. The resulting collection is read-only.
If the type is not one of the collection types listed in 5 above and the matrix parameter is represented by multiple values then the first value (lexically) of the parameter is used.
Because injection occurs at object creation time, use of this annotation on resource class fields and bean properties is only supported for the default per-request resource class lifecycle. Resource classes using other lifecycles should only use this annotation on resource method parameters.
- Since:
- 1.0
- Author:
- Paul Sandoz, Marc Hadley
- See Also:
DefaultValue
,Encoded
, Matrix URIs
-
Element Details
-
value
String valueDefines the name of the URI matrix parameter whose value will be used to initialize the value of the annotated method argument, class field or bean property. The name is specified in decoded form, any percent encoded literals within the value will not be decoded and will instead be treated as literal text. E.g. if the parameter name is "a b" then the value of the annotation is "a b", not "a+b" or "a%20b".- Returns:
- URI matrix parameter name.
-