Interface ParamConverter<T>
- Type Parameters:
T
- the supported Java type convertible to/from aString
format.
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.
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
Modifier and TypeInterfaceDescriptionstatic @interface
Mandates that a conversion of anydefault value
delegated to aparameter converter
annotated with@Lazy
annotation SHOULD occur only once the value is actually required (e.g. -
Method Summary
-
Method Details
-
fromString
Parse the supplied value and create an instance ofT
.- Parameters:
value
- the string value.- Returns:
- the newly created instance of
T
. - Throws:
IllegalArgumentException
- if the supplied string cannot be parsed or isnull
.
-
toString
Convert the supplied value to a String.This method is reserved for future use. Proprietary JAX-RS extensions may leverage the method. Users should be aware that any such support for the method comes at the expense of producing non-portable code.
- Parameters:
value
- the value of typeT
.- Returns:
- a String representation of the value.
- Throws:
IllegalArgumentException
- if the supplied object cannot be serialized or isnull
.
-