ProtoConverterFactory (Retrofit (Parent) 2.3.0 API)

java.lang.Object
- retrofit2.Converter.Factory
- - retrofit2.converter.protobuf.ProtoConverterFactory

```
public final class ProtoConverterFactory
extends Converter.Factory
```
A converter which uses Protocol Buffers.
This converter only applies for types which extend from MessageLite (or one of its subclasses).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ProtoConverterFactory`	`create()`
`static ProtoConverterFactory`	`createWithRegistry(com.google.protobuf.ExtensionRegistryLite registry)` Create an instance which uses `registry` when deserializing.
`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 ProtoConverterFactory create()

createWithRegistry

public static ProtoConverterFactory createWithRegistry(@Nullable
                                                       com.google.protobuf.ExtensionRegistryLite registry)

Create an instance which uses registry when deserializing.

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

Class ProtoConverterFactory