@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
@Documented
public @interface FormParam
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.
The type T
of the annotated parameter must either:
String
argumentvalueOf
or fromString
that accepts a single String
argument
(see, for example, Integer.valueOf(String)
)ParamConverterProvider
JAX-RS extension SPI that
returns a ParamConverter
instance capable of a "from string" conversion for the type.List<T>
, Set<T>
or SortedSet<T>
, where T
satisfies 2, 3 or 4 above. The
resulting collection is read-only.If the type is not one of the collection types listed in 5 above and the form parameter is represented by multiple values then the first value (lexically) of the parameter is used.
If this annotation is used to bind form parameters, a JAX-RS implementation MUST use the entity provider API
to create a Form
and derive the values from this instance. If there is at least one
FormParam
for a resource method, JAX-RS implementations MUST support a Form
entity parameter for the same method. Support for other entity parameter types is OPTIONAL.
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
Modifier and Type | Required Element and Description |
---|---|
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.
|
public abstract java.lang.String value