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 singlejavax.ws.rs.ext.ParamConverterProvider
JAX-RS extension SPI that returns a javax.ws.rs.ext.ParamConverter
instance capable of a "from string" conversion for the type.String argument (see, for example, Integer#valueOf(String))
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.
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 | Method and Description |
|---|---|
| public String | value()
Defines the name of the form parameter whose value will be used to initialize the value of the annotated method argument. |
| value | back to summary |
|---|---|
| public String value() Defines the name of the form parameter whose value will be used to initialize the value of the annotated method argument. The name is specified in decoded form, any percent encoded literals within the value will not be decoded and will instead be treated as literal text. E.g. if the parameter name is "a b" then the value of the annotation is "a b", not "a+b" or "a%20b". | |