javax.ws.rs
Annotation Type PathParam

@Target(value=PARAMETER)
@Retention(value=RUNTIME)
public @interface PathParam

Binds a method parameter to a URI template parameter value. The value is URL decoded unless this is disabled using the Encoded annotation. The type of the annotated parameter must either:

• Be 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.
• Be a primitive type.
• Have a constructor that accepts a single String argument.
• Have a static method named valueOf that accepts a single String argument (see, for example, Integer.valueOf(String)).

See Also:

Encoded, PathSegment

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

value

public abstract 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.

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").