retrofit2.converter.wire

Class WireConverterFactory

java.lang.Object

retrofit2.Converter.Factory

retrofit2.converter.wire.WireConverterFactory

public final class WireConverterFactory
extends retrofit2.Converter.Factory

A converter that uses Wire for protocol buffers.

This converter only applies for types which extend from Message.

Method Summary

Modifier and Type	Method and Description
static WireConverterFactory	create() Create an instance which serializes request messages to bytes eagerly on the caller thread when either Call.execute() or Call.enqueue(retrofit2.Callback<T>) is called.
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)
WireConverterFactory	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 WireConverterFactory create()

Create an instance which serializes request messages to bytes eagerly on the caller thread when either Call.execute() or Call.enqueue(retrofit2.Callback<T>) is called. Response bytes are always converted to message instances on one of OkHttp's background threads.

withStreaming

public WireConverterFactory 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