|
||||||||||
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 HTTP request representation form 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.
This annotation is valid only on resource method signatures whose parameters are all annotated with at least one parameter annotated with this annotation.
The type T
of the annotated parameter, field or property must
either:
String
argumentvalueOf
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.
Use of this annotation on resource class fields and bean properties not supported and will result in a runtime exception.
DefaultValue
,
Encoded
,
Form
Required Element Summary | |
---|---|
java.lang.String |
value
Defines the name of the HTTP form 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 form parameter name is URL encoded. |
Element Detail |
---|
public abstract java.lang.String value
public abstract boolean encode
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |