Top Description Methods
jakarta.ws.rs.ext

public Interface ParamConverterProvider

Imports
java.lang.annotation.Annotation, java.lang.reflect.Type
Contract for a provider of ParamConverter instances.

Providers implementing ParamConverterProvider contract must be either programmatically registered in a JAX-RS runtime or must be annotated with @Provider annotation to be automatically discovered by the JAX-RS runtime during a provider scanning phase.

Author
Marek Potociar
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public <
the supported Java type convertible to/from a String format.
T> ParamConverter<T>

Returns:

the string converter, otherwise null.
getConverter(Class<T>
the raw type of the object to be converted.
rawType, Type
the type of object to be converted. E.g. if an String value representing the injected request parameter is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Class.getGenericParameterTypes.
genericType, Annotation[]
an array of the annotations associated with the convertible parameter instance. E.g. if a string value is to be converted into a method parameter, this would be the annotations on that parameter as returned by java.lang.reflect.Method#getParameterAnnotations.
annotations)

Obtain a ParamConverter that can provide from/to string conversion for an instance of a particular Java type.

Method Detail

getConverterback to summary
public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation[] annotations)

Obtain a ParamConverter that can provide from/to string conversion for an instance of a particular Java type.

Parameters
<T>
the supported Java type convertible to/from a String format.
rawType:Class<T>

the raw type of the object to be converted.

genericType:Type

the type of object to be converted. E.g. if an String value representing the injected request parameter is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Class.getGenericParameterTypes.

annotations:Annotation[]

an array of the annotations associated with the convertible parameter instance. E.g. if a string value is to be converted into a method parameter, this would be the annotations on that parameter as returned by java.lang.reflect.Method#getParameterAnnotations.

Returns:ParamConverter<T>

the string converter, otherwise null.