-
- 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
.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 18/08/2025
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-javaee-rf-javax/ws/rs/ext/paramconverter.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor dieser Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.