@Encoded annotation.
A default value can be specified using the @DefaultValue
annotation.
The type of the annotated parameter, field or property must either:
javax.ws.rs.core.PathSegment, the value will be the final
segment of the matching part of the path.
See javax.ws.rs.core.UriInfo for a means of retrieving all request
path segments.List<javax.ws.rs.core.PathSegment>, the
value will be a list of PathSegment corresponding to the path
segment(s) that matched the named template parameter.
See javax.ws.rs.core.UriInfo for a means of retrieving all request
path segments.valueOf or fromString
that accepts a single
String argument (see, for example, Integer#valueOf(String)).javax.ws.rs.ext.ParamConverterProvider
JAX-RS extension SPI that returns a javax.ws.rs.ext.ParamConverter
instance capable of a "from string" conversion for the type.The injected value corresponds to the latest use (in terms of scope) of
the path parameter. E.g. if a class and a sub-resource method are both
annotated with a @Path containing the same URI template
parameter, use of @PathParam on a sub-resource method parameter
will bind the value matching URI template parameter in the method's
@Path annotation.
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.
@Encoded, @DefaultValue, javax.ws.rs.core.PathSegment, javax.ws.rs.core.UriInfo
| Modifier and Type | Method and Description |
|---|---|
| public String | value()
Defines the name of the URI template parameter whose value will be used to initialize the value of the annotated method parameter, class field or property. |
| value | back to summary |
|---|---|
| public String value() Defines the name of the URI template parameter whose value will be used
to initialize the value of the annotated method parameter, class field or
property. See E.g. a class annotated with: | |