retrofit2.converter.gson

Class GsonConverterFactory

java.lang.Object

retrofit2.Converter.Factory

retrofit2.converter.gson.GsonConverterFactory

public final class GsonConverterFactory
extends Converter.Factory

A converter which uses Gson for JSON.

Because Gson is so flexible in the types it supports, this converter assumes that it can handle all types. If you are mixing JSON serialization with something else (such as protocol buffers), you must add this instance last to allow the other converters a chance to see their types.

Method Summary

Modifier and Type	Method and Description
static GsonConverterFactory	create() Create an instance using a default Gson instance for conversion.
static GsonConverterFactory	create(com.google.gson.Gson gson) Create an instance using gson for conversion.
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.

Methods inherited from class retrofit2.Converter.Factory

getParameterUpperBound, getRawType, stringConverter

Methods inherited from class java.lang.Object

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

Method Detail

create

public static GsonConverterFactory create()

Create an instance using a default Gson instance for conversion. Encoding to JSON and decoding from JSON (when no charset is specified by a header) will use UTF-8.

create

public static GsonConverterFactory create(com.google.gson.Gson gson)

Create an instance using gson for conversion. Encoding to JSON and decoding from JSON (when no charset is specified by a header) will use UTF-8.

responseBodyConverter

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

Description copied from class: Converter.Factory

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.

Overrides:

responseBodyConverter in class Converter.Factory

requestBodyConverter

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

Description copied from class: Converter.Factory

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.

Overrides:

requestBodyConverter in class Converter.Factory