|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=PARAMETER) @Retention(value=RUNTIME) public @interface PathParam
Binds a method parameter to a URI template parameter value or a path segment
containing the template parameter. The value is URL decoded unless this
is disabled using the Encoded
annotation.
The type of the annotated parameter must either:
PathSegment
, the value will be a PathSegment
corresponding to the path segment that contains the named template parameter.
See UriInfo
for a means of retrieving all request
path segments.valueOf
that accepts a single
String argument (see, for example, Integer.valueOf(String)
).
Encoded
,
PathSegment
,
UriInfo
Required Element Summary | |
---|---|
java.lang.String |
value
Defines the name of the URI template parameter who value will be used to initialize the value of the annotated method parameter, class field or property. |
Element Detail |
---|
public abstract java.lang.String value
E.g. a class annotated with: @Path("widgets/{id}")
can have methods annotated with a HTTP method annotation whose arguments are annotated
with @PathParam("id")
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |