retrofit2.converter.moshi

Class MoshiConverterFactory

java.lang.Object

retrofit2.Converter.Factory

retrofit2.converter.moshi.MoshiConverterFactory

public final class MoshiConverterFactory
extends Converter.Factory

A converter which uses Moshi for JSON.

Because Moshi 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.

Any @JsonQualifier-annotated annotations on the parameter will be used when looking up a request body converter and those on the method will be used when looking up a response body converter.

Method Summary

Modifier and Type	Method and Description
MoshiConverterFactory	asLenient() Return a new factory which uses lenient adapters.
static MoshiConverterFactory	create() Create an instance using a default Moshi instance for conversion.
static MoshiConverterFactory	create(com.squareup.moshi.Moshi moshi) Create an instance using moshi for conversion.
MoshiConverterFactory	failOnUnknown() Return a new factory which uses JsonAdapter.failOnUnknown() adapters.
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.
MoshiConverterFactory	withNullSerialization() Return a new factory which includes null values into the serialized JSON.

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 MoshiConverterFactory create()

Create an instance using a default Moshi instance for conversion.

create

public static MoshiConverterFactory create(com.squareup.moshi.Moshi moshi)

Create an instance using moshi for conversion.

asLenient

public MoshiConverterFactory asLenient()

Return a new factory which uses lenient adapters.

failOnUnknown

public MoshiConverterFactory failOnUnknown()

Return a new factory which uses JsonAdapter.failOnUnknown() adapters.

withNullSerialization

public MoshiConverterFactory withNullSerialization()

Return a new factory which includes null values into the serialized JSON.

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