-
- Type Parameters:
T
- the supported Java type convertible to/from aString
format.
public interface ParamConverter<T>
Defines a contract for a delegate responsible for converting between aString
form of a message parameter value and the corresponding custom Java typeT
. 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 anydefault 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 theParamConverter
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 providingParamConverter
instances has to be registered as one of the JAX-RS extension providers.- Author:
- Marek Potociar
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interface
ParamConverter.Lazy
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
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description T
fromString(String value)
Parse the supplied value and create an instance ofT
.String
toString(T value)
Convert the supplied value to a String.
-
-
-
Method Detail
-
fromString
T fromString(String value)
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
String toString(T value)
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
.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/ext/paramconverter.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.