@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=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:
String
argumentvalueOf
or fromString
that accepts a single String
argument
(see, for example, Integer.valueOf(String)
)ParamConverterProvider
JAX-RS extension SPI that
returns a ParamConverter
instance capable of a "from string" conversion for the type.List<T>
, Set<T>
or SortedSet<T>
, where T
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.
DefaultValue
,
Encoded
,
Matrix URIsModifier and Type | Required Element and Description |
---|---|
java.lang.String |
value
Defines 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.
|
public abstract java.lang.String value