org.glassfish.jersey.spi
Interface StringValueReaderProvider

public interface StringValueReaderProvider

Contract for a provider that supports the conversion of a string to a Java type. To add a StringValueReaderProvider implementation, annotate the implementation class with Provider.

Such providers will be used when converting a String value to a java type annotated by the *Param annotations such as QueryParam.

Author:

Paul Sandoz, Marek Potociar (marek.potociar at oracle.com)

See Also:

Provider

Method Summary

<T> StringValueReader<T>

getStringReader(java.lang.Class<T> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations) Obtain a StringValueReader that can produce an instance of a particular type from a string.

Method Detail

getStringReader

<T> StringValueReader<T> getStringReader(java.lang.Class<T> type,
                                         java.lang.reflect.Type genericType,
                                         java.lang.annotation.Annotation[] annotations)

Obtain a StringValueReader that can produce an instance of a particular type from a string.

Type Parameters:

T - The Java type to be produced.

Parameters:

type - the class of object to be produced.

genericType - the type of object to be produced. E.g. if the string is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Class.getGenericParameterTypes.

annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the string is to be converted into a method parameter, this will be the annotations on that parameter returned by Class.getParameterAnnotations.

Returns:

the string reader, otherwise null.