|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- the supported Java type convertible to/from a String
format.public interface ParamConverter<T>
Defines a contract for a delegate responsible for converting between a
String
form of a message parameter value and the corresponding custom
Java type T
. Conversion of message parameter values injected via
@PathParam
, @QueryParam
,
@MatrixParam
, @FormParam
,
@CookieParam
and @HeaderParam
is supported as well as conversion of any parameter values passed to
a JAX-RS client API or Response.ResponseBuilder
method.
By default, when used for injection of parameter values, a selected ParamConverter
instance MUST be used eagerly by a JAX-RS runtime to convert any default value
in the resource or provider model, that is during the application deployment,
before any value – default or otherwise – is actually required.
This conversion strategy ensures that any errors in the default values are reported
as early as possible.
This default behavior may be overridden by annotating the ParamConverter
implementation class with a @Lazy
annotation. In such case any default
value conversion delegated to the @Lazy
-annotated converter will be deferred
to a latest possible moment (i.e. until the injection of such default value is required).
NOTE: A service implementing this contract is not recognized as a registrable
JAX-RS extension provider. Instead, a ParamConverterProvider
instance
responsible for providing ParamConverter
instances has to be registered
as one of the JAX-RS extension providers.
Nested Class Summary | |
---|---|
static interface |
ParamConverter.Lazy
Mandates that a conversion of any default value delegated
to a parameter converter annotated with @Lazy
annotation SHOULD occur only once the value is actually required (e.g. |
Method Summary | |
---|---|
T |
fromString(java.lang.String value)
Parse the supplied value and create an instance of T . |
java.lang.String |
toString(T value)
Convert the supplied value to a String. |
Method Detail |
---|
T fromString(java.lang.String value) throws java.lang.IllegalArgumentException
T
.
value
- the string value.
T
.
java.lang.IllegalArgumentException
- if the supplied string cannot be
parsed or is null
.java.lang.String toString(T value) throws java.lang.IllegalArgumentException
value
- the value of type T
.
java.lang.IllegalArgumentException
- if the supplied object cannot be
serialized or is null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |