retrofit

Class RestAdapter.Builder

java.lang.Object

retrofit.RestAdapter.Builder

Enclosing class:

RestAdapter

public static class RestAdapter.Builder
extends Object

Build a new RestAdapter.

Calling the following methods is required before calling build():

• setServer(Server)
• setClient(Client.Provider)
• setConverter(Converter)

If you are using asynchronous execution (i.e., with Callbacks) the following is also required:

• setExecutors(java.util.concurrent.Executor, java.util.concurrent.Executor)

Constructor Summary

Constructors

Constructor and Description
RestAdapter.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
RestAdapter	build() Create the RestAdapter instances.
RestAdapter.Builder	setClient(Client.Provider clientProvider) The HTTP client used for requests.
RestAdapter.Builder	setClient(Client client) The HTTP client used for requests.
RestAdapter.Builder	setConverter(Converter converter) The converter used for serialization and deserialization of objects.
RestAdapter.Builder	setErrorHandler(ErrorHandler errorHandler) The error handler allows you to customize the type of exception thrown for errors on synchronous requests.
RestAdapter.Builder	setExecutors(Executor httpExecutor, Executor callbackExecutor) Executors used for asynchronous HTTP client downloads and callbacks.
RestAdapter.Builder	setLog(RestAdapter.Log log) Configure debug logging mechanism.
RestAdapter.Builder	setLogLevel(RestAdapter.LogLevel logLevel) Change the level of logging.
RestAdapter.Builder	setProfiler(Profiler profiler) Set the profiler used to measure requests.
RestAdapter.Builder	setRequestInterceptor(RequestInterceptor requestInterceptor) A request interceptor for adding data to every request.
RestAdapter.Builder	setServer(Server server) API server.
RestAdapter.Builder	setServer(String endpoint) API server base URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestAdapter.Builder

public RestAdapter.Builder()

Method Detail

setServer

public RestAdapter.Builder setServer(String endpoint)

API server base URL.

setServer

public RestAdapter.Builder setServer(Server server)

API server.

setClient

public RestAdapter.Builder setClient(Client client)

The HTTP client used for requests.

setClient

public RestAdapter.Builder setClient(Client.Provider clientProvider)

The HTTP client used for requests.

setExecutors

public RestAdapter.Builder setExecutors(Executor httpExecutor,
                               Executor callbackExecutor)

Executors used for asynchronous HTTP client downloads and callbacks.

Parameters:

httpExecutor - Executor on which HTTP client calls will be made.

callbackExecutor - Executor on which any Callback methods will be invoked. If this argument is null then callback methods will be run on the same thread as the HTTP client.

setRequestInterceptor

public RestAdapter.Builder setRequestInterceptor(RequestInterceptor requestInterceptor)

A request interceptor for adding data to every request.

setConverter

public RestAdapter.Builder setConverter(Converter converter)

The converter used for serialization and deserialization of objects.

setProfiler

public RestAdapter.Builder setProfiler(Profiler profiler)

Set the profiler used to measure requests.

setErrorHandler

public RestAdapter.Builder setErrorHandler(ErrorHandler errorHandler)

The error handler allows you to customize the type of exception thrown for errors on synchronous requests.

setLog

public RestAdapter.Builder setLog(RestAdapter.Log log)

Configure debug logging mechanism.

setLogLevel

public RestAdapter.Builder setLogLevel(RestAdapter.LogLevel logLevel)

Change the level of logging.

build

public RestAdapter build()

Create the RestAdapter instances.