retrofit2

Class Converter.Factory

java.lang.Object

retrofit2.Converter.Factory

Direct Known Subclasses:

GsonConverterFactory, GuavaOptionalConverterFactory, JacksonConverterFactory, Java8OptionalConverterFactory, MoshiConverterFactory, ProtoConverterFactory, ScalarsConverterFactory, SimpleXmlConverterFactory, WireConverterFactory

Enclosing interface:

Converter<F,T>

public abstract static class Converter.Factory
extends Object

Creates Converter instances based on a type and target usage.

Constructor Summary

Constructors

Constructor and Description
Factory()

Method Summary

Modifier and Type	Method and Description
protected static Type	getParameterUpperBound(int index, ParameterizedType type) Extract the upper bound of the generic parameter at index from type.
protected static Class<?>	getRawType(Type type) Extract the raw class type from type.
Converter<?,okhttp3.RequestBody>	requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) Returns a Converter for converting type to an HTTP request body, or null if type cannot be handled by this factory.
Converter<okhttp3.ResponseBody,?>	responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) Returns a Converter for converting an HTTP response body to type, or null if type cannot be handled by this factory.
Converter<?,String>	stringConverter(Type type, Annotation[] annotations, Retrofit retrofit) Returns a Converter for converting type to a String, or null if type cannot be handled by this factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Factory

public Factory()

Method Detail

responseBodyConverter

@Nullable
public Converter<okhttp3.ResponseBody,?> responseBodyConverter(Type type,
                                                                         Annotation[] annotations,
                                                                         Retrofit retrofit)

Returns a Converter for converting an HTTP response body to type, or null if type cannot be handled by this factory. This is used to create converters for response types such as SimpleResponse from a Call<SimpleResponse> declaration.

requestBodyConverter

@Nullable
public Converter<?,okhttp3.RequestBody> requestBodyConverter(Type type,
                                                                       Annotation[] parameterAnnotations,
                                                                       Annotation[] methodAnnotations,
                                                                       Retrofit retrofit)

Returns a Converter for converting type to an HTTP request body, or null if type cannot be handled by this factory. This is used to create converters for types specified by @Body, @Part, and @PartMap values.

stringConverter

@Nullable
public Converter<?,String> stringConverter(Type type,
                                                     Annotation[] annotations,
                                                     Retrofit retrofit)

Returns a Converter for converting type to a String, or null if type cannot be handled by this factory. This is used to create converters for types specified by @Field, @FieldMap values, @Header, @HeaderMap, @Path, @Query, and @QueryMap values.

getParameterUpperBound

protected static Type getParameterUpperBound(int index,
                                             ParameterizedType type)

Extract the upper bound of the generic parameter at index from type. For example, index 1 of Map<String, ? extends Runnable> returns Runnable.

getRawType

protected static Class<?> getRawType(Type type)

Extract the raw class type from type. For example, the type representing List<? extends Runnable> returns List.class.