retrofit
Class RestAdapter.Builder

java.lang.Object
  extended by 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():

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


Constructor Summary
RestAdapter.Builder()
           
 
Method Summary
 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 setDebug(boolean debug)
          Enable debug logging.
 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 setProfiler(Profiler profiler)
          Set the profiler used to measure requests.
 RestAdapter.Builder setRequestHeaders(RequestHeaders requestHeaders)
           
 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.

setRequestHeaders

public RestAdapter.Builder setRequestHeaders(RequestHeaders requestHeaders)

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.


setLog

public RestAdapter.Builder setLog(RestAdapter.Log log)
Configure debug logging mechanism.


setDebug

public RestAdapter.Builder setDebug(boolean debug)
Enable debug logging.


build

public RestAdapter build()
Create the RestAdapter instances.



Copyright © 2013 Square, Inc.. All Rights Reserved.