|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value={PARAMETER,METHOD,FIELD}) @Retention(value=RUNTIME) public @interface FormParam
Binds the value(s) of a form parameter contained within a request entity body
to a resource method parameter. Values are URL decoded unless this is
disabled using the Encoded
annotation. A default value can be
specified using the DefaultValue
annotation.
If the request entity body is absent or is an unsupported media type, the
default value is used.
T
of the annotated parameter must either:
String
argumentvalueOf
or fromString
that accepts a single
String
argument (see, for example, Integer.valueOf(String)
)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.
Note that, whilst the annotation target permits use on fields and methods, this annotation is only required to be supported on resource method parameters.
DefaultValue
,
Encoded
Required Element Summary | |
---|---|
java.lang.String |
value
Defines the name of the form parameter whose value will be used to initialize the value of the annotated method argument. |
Element Detail |
---|
public abstract java.lang.String value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |