retrofit2.converter.simplexml

Class SimpleXmlConverterFactory

java.lang.Object

retrofit2.Converter.Factory

retrofit2.converter.simplexml.SimpleXmlConverterFactory

public final class SimpleXmlConverterFactory
extends Converter.Factory

A converter which uses Simple Framework for XML.

This converter only applies for class types. Parameterized types (e.g., List<Foo>) are not handled.

Method Summary

Modifier and Type	Method and Description
static SimpleXmlConverterFactory	create() Create an instance using a default Persister instance for conversion.
static SimpleXmlConverterFactory	create(org.simpleframework.xml.Serializer serializer) Create an instance using serializer for conversion.
static SimpleXmlConverterFactory	createNonStrict() Create an instance using a default Persister instance for non-strict conversion.
static SimpleXmlConverterFactory	createNonStrict(org.simpleframework.xml.Serializer serializer) Create an instance using serializer for non-strict conversion.
boolean	isStrict()
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 SimpleXmlConverterFactory create()

Create an instance using a default Persister instance for conversion.

create

public static SimpleXmlConverterFactory create(org.simpleframework.xml.Serializer serializer)

Create an instance using serializer for conversion.

createNonStrict

public static SimpleXmlConverterFactory createNonStrict()

Create an instance using a default Persister instance for non-strict conversion.

createNonStrict

public static SimpleXmlConverterFactory createNonStrict(org.simpleframework.xml.Serializer serializer)

Create an instance using serializer for non-strict conversion.

isStrict

public boolean isStrict()

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