retrofit2.converter.jackson

Class JacksonConverterFactory

java.lang.Object

retrofit2.Converter.Factory

retrofit2.converter.jackson.JacksonConverterFactory

public final class JacksonConverterFactory
extends Converter.Factory

A converter which uses Jackson.

Because Jackson 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 JacksonConverterFactory	create() Create an instance using a default ObjectMapper instance for conversion.
static JacksonConverterFactory	create(com.fasterxml.jackson.databind.ObjectMapper mapper) Create an instance using mapper 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 JacksonConverterFactory create()

Create an instance using a default ObjectMapper instance for conversion.

create

public static JacksonConverterFactory create(com.fasterxml.jackson.databind.ObjectMapper mapper)

Create an instance using mapper for conversion.

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