retrofit2.adapter.java8

Class Java8CallAdapterFactory

java.lang.Object

retrofit2.CallAdapter.Factory

retrofit2.adapter.java8.Java8CallAdapterFactory

public final class Java8CallAdapterFactory
extends CallAdapter.Factory

A call adapter which creates Java 8 futures.

Adding this class to Retrofit allows you to return CompletableFuture from service methods.

 interface MyService {
   @GET("user/me")
   CompletableFuture<User> getUser()
 }
 

There are two configurations supported for the CompletableFuture type parameter:

• Direct body (e.g., CompletableFuture<User>) returns the deserialized body for 2XX responses, sets HttpException errors for non-2XX responses, and sets IOException for network errors.
• Response wrapped body (e.g., CompletableFuture<Response<User>>) returns a Response object for all HTTP responses and sets IOException for network errors

Method Summary

Modifier and Type	Method and Description
static Java8CallAdapterFactory	create()
CallAdapter<?,?>	get(Type returnType, Annotation[] annotations, Retrofit retrofit) Returns a call adapter for interface methods that return returnType, or null if it cannot be handled by this factory.

Methods inherited from class retrofit2.CallAdapter.Factory

getParameterUpperBound, getRawType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Java8CallAdapterFactory create()

get

public CallAdapter<?,?> get(Type returnType,
                            Annotation[] annotations,
                            Retrofit retrofit)

Description copied from class: CallAdapter.Factory

Returns a call adapter for interface methods that return returnType, or null if it cannot be handled by this factory.

Specified by:

get in class CallAdapter.Factory