retrofit2.converter.protobuf

Class ProtoConverterFactory

java.lang.Object

retrofit2.Converter.Factory

retrofit2.converter.protobuf.ProtoConverterFactory

public final class ProtoConverterFactory
extends retrofit2.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

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.
retrofit2.Converter<?,okhttp3.RequestBody>	requestBodyConverter(java.lang.reflect.Type type, java.lang.annotation.Annotation[] parameterAnnotations, java.lang.annotation.Annotation[] methodAnnotations, retrofit2.Retrofit retrofit)
retrofit2.Converter<okhttp3.ResponseBody,?>	responseBodyConverter(java.lang.reflect.Type type, java.lang.annotation.Annotation[] annotations, retrofit2.Retrofit retrofit)
ProtoConverterFactory	withStreaming() Return a new factory which streams serialization of request messages to bytes on the HTTP thread This is either the calling thread for Call.execute(), or one of OkHttp's background threads for Call.enqueue(retrofit2.Callback<T>).

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.

withStreaming

public ProtoConverterFactory withStreaming()

Return a new factory which streams serialization of request messages to bytes on the HTTP thread This is either the calling thread for Call.execute(), or one of OkHttp's background threads for Call.enqueue(retrofit2.Callback<T>). Response bytes are always converted to message instances on one of OkHttp's background threads.

responseBodyConverter

@Nullable
public retrofit2.Converter<okhttp3.ResponseBody,?> responseBodyConverter(java.lang.reflect.Type type,
                                                                                   java.lang.annotation.Annotation[] annotations,
                                                                                   retrofit2.Retrofit retrofit)

Overrides:

responseBodyConverter in class retrofit2.Converter.Factory

requestBodyConverter

@Nullable
public retrofit2.Converter<?,okhttp3.RequestBody> requestBodyConverter(java.lang.reflect.Type type,
                                                                                 java.lang.annotation.Annotation[] parameterAnnotations,
                                                                                 java.lang.annotation.Annotation[] methodAnnotations,
                                                                                 retrofit2.Retrofit retrofit)

Overrides:

requestBodyConverter in class retrofit2.Converter.Factory