javax.ws.rs
Annotation Type QueryParam

@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface QueryParam

Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property. Values are URL decoded unless this is disabled using the Encoded annotation. A default value can be specified using the DefaultValue annotation.

The type T of the annotated parameter, field or property must either:

1. Be a primitive type
2. Have a constructor that accepts a single String argument
3. Have a static method named valueOf that accepts a single String argument (see, for example, Integer.valueOf(String))
4. Be List<T>, Set<T> or SortedSet<T>, where T satisfies 2 or 3 above. The resulting collection is read-only.

If the type is not one of those listed in 4 above 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.

See Also:

DefaultValue, Encoded, UriInfo.getQueryParameters()

Required Element Summary

java.lang.String

value Defines the name of the HTTP query parameter whose value will be used to initialize the value of the annotated method argument, class field or bean property.

Optional Element Summary

boolean

encode Controls whether the the supplied query parameter name is URL encoded.

Element Detail

value

public abstract java.lang.String value

Defines the name of the HTTP query parameter whose value will be used to initialize the value of the annotated method argument, class field or bean property.

encode

public abstract boolean encode

Controls whether the the supplied query parameter name is URL encoded. If true, any characters in the query parameter name that are not valid URI characters will be automatically encoded. If false then all characters in the supplied name must be valid URI characters.

Default:

true