A B C D E F G H I L M N O P Q R S T U V W

A

addEncodedPathParam(String, String) - Method in interface retrofit.RequestInterceptor.RequestFacade

Add a path parameter replacement without first URI encoding.

addEncodedQueryParam(String, String) - Method in interface retrofit.RequestInterceptor.RequestFacade

Add an additional query parameter without first URI encoding.

addField(String, String) - Method in class retrofit.mime.FormUrlEncodedTypedOutput

addHeader(String, String) - Method in interface retrofit.RequestInterceptor.RequestFacade

Add a header to the request.

addPart(String, TypedOutput) - Method in class retrofit.mime.MultipartTypedOutput

addPathParam(String, String) - Method in interface retrofit.RequestInterceptor.RequestFacade

Add a path parameter replacement.

addQueryParam(String, String) - Method in interface retrofit.RequestInterceptor.RequestFacade

Add an additional query parameter.

afterCall(Profiler.RequestInformation, long, int, T) - Method in interface retrofit.Profiler

Invoked after an HTTP method completes.

AndroidApacheClient - Class in retrofit.android

Provides a Client which uses the Android-specific version of HttpClient, AndroidHttpClient.

AndroidApacheClient() - Constructor for class retrofit.android.AndroidApacheClient

AndroidLog - Class in retrofit.android

A logger for Android.

AndroidLog(String) - Constructor for class retrofit.android.AndroidLog

ApacheClient - Class in retrofit.client

A Client which uses an implementation of Apache's HttpClient.

ApacheClient() - Constructor for class retrofit.client.ApacheClient

Creates an instance backed by DefaultHttpClient.

ApacheClient(HttpClient) - Constructor for class retrofit.client.ApacheClient

B

beforeCall() - Method in interface retrofit.Profiler

Invoked before an HTTP method call.

Body - Annotation Type in retrofit.http

Use this annotation on a service method param when you want to directly control the request body of a POST/PUT request (instead of sending in as request parameters or form-style request body).

build() - Method in class retrofit.RestAdapter.Builder

Create the RestAdapter instances.

Builder() - Constructor for class retrofit.RestAdapter.Builder

C

Callback<T> - Interface in retrofit

Communicates responses from a server or offline requests.

ChangeableServer - Class in retrofit

Deprecated.

Implement Endpoint to change URL and name at runtime. This class will be removed in version 1.5.

ChangeableServer(String) - Constructor for class retrofit.ChangeableServer

Deprecated.

Create a changeable server with the provided URL and default name.

ChangeableServer(String, String) - Constructor for class retrofit.ChangeableServer

Deprecated.

Create a changeable server with the provided URL and name.

Client - Interface in retrofit.client

Abstraction of an HTTP client which can execute Requests.

Client.Provider - Interface in retrofit.client

Deferred means of obtaining a Client.

conversionError(String, Response, Converter, Type, ConversionException) - Static method in exception retrofit.RetrofitError

ConversionException - Exception in retrofit.converter

Indicate that conversion was unable to complete successfully.

ConversionException(String) - Constructor for exception retrofit.converter.ConversionException

ConversionException(String, Throwable) - Constructor for exception retrofit.converter.ConversionException

ConversionException(Throwable) - Constructor for exception retrofit.converter.ConversionException

Converter - Interface in retrofit.converter

Arbiter for converting objects to and from their representation in HTTP.

create(Class<T>) - Method in class retrofit.RestAdapter

Create an implementation of the API defined by the specified service interface.

D

DEFAULT - Static variable in interface retrofit.ErrorHandler

An ErrorHandler which returns the original error.

DEFAULT_NAME - Static variable in class retrofit.Server

Deprecated.

DELETE - Annotation Type in retrofit.http

Make a DELETE request to a REST path relative to base URL.

E

EncodedPath - Annotation Type in retrofit.http

Named replacement in the URL path.

EncodedQuery - Annotation Type in retrofit.http

Encoded query parameter appended to the URL.

EncodedQueryMap - Annotation Type in retrofit.http

Query keys and values appended to the URL.

Endpoint - Interface in retrofit

Represents an API endpoint URL and associated name.

Endpoints - Class in retrofit

Static factory methods for creating Endpoint instances.

equals(Object) - Method in class retrofit.client.Header

equals(Object) - Method in class retrofit.mime.TypedByteArray

equals(Object) - Method in class retrofit.mime.TypedFile

ErrorHandler - Interface in retrofit

A hook allowing clients to customize response exceptions.

execute(Runnable) - Method in class retrofit.android.MainThreadExecutor

execute(Request) - Method in class retrofit.appengine.UrlFetchClient

execute(URLFetchService, HTTPRequest) - Method in class retrofit.appengine.UrlFetchClient

Execute the specified request using the provided urlFetchService.

execute(Request) - Method in class retrofit.client.ApacheClient

execute(HttpClient, HttpUriRequest) - Method in class retrofit.client.ApacheClient

Execute the specified request using the provided client.

execute(Request) - Method in interface retrofit.client.Client

Synchronously execute an HTTP represented by request and encapsulate all response data into a Response instance.

execute(Request) - Method in class retrofit.client.UrlConnectionClient

F

failure(RetrofitError) - Method in interface retrofit.Callback

Unsuccessful HTTP response due to network failure, non-2XX status code, or unexpected exception.

Field - Annotation Type in retrofit.http

Named pair for a form-encoded request.

FieldMap - Annotation Type in retrofit.http

Named key/value pairs for a form-encoded request.

file() - Method in class retrofit.mime.TypedFile

Returns the file.

fileName() - Method in class retrofit.mime.FormUrlEncodedTypedOutput

fileName() - Method in class retrofit.mime.MultipartTypedOutput

fileName() - Method in class retrofit.mime.TypedByteArray

fileName() - Method in class retrofit.mime.TypedFile

fileName() - Method in interface retrofit.mime.TypedOutput

Original filename.

FormUrlEncoded - Annotation Type in retrofit.http

Denotes that the request body will use form URL encoding.

FormUrlEncodedTypedOutput - Class in retrofit.mime

FormUrlEncodedTypedOutput() - Constructor for class retrofit.mime.FormUrlEncodedTypedOutput

fromBody(TypedInput, Type) - Method in interface retrofit.converter.Converter

Convert an HTTP response body to a concrete object of the specified type.

fromBody(TypedInput, Type) - Method in class retrofit.converter.GsonConverter

G

get() - Method in interface retrofit.client.Client.Provider

Obtain an HTTP client.

GET - Annotation Type in retrofit.http

Make a GET request to a REST path relative to base URL.

getBaseUrl() - Method in class retrofit.Profiler.RequestInformation

Returns the URL to which the originating request was sent.

getBody() - Method in class retrofit.client.Request

Returns the request body or null.

getBody() - Method in class retrofit.client.Response

Response body.

getBody() - Method in exception retrofit.RetrofitError

HTTP response body converted to the type declared by either the interface method return type or the generic type of the supplied Callback parameter.

getBodyAs(Type) - Method in exception retrofit.RetrofitError

HTTP response body converted to specified type.

getBytes() - Method in class retrofit.mime.TypedByteArray

getContentLength() - Method in class retrofit.Profiler.RequestInformation

Returns the number of bytes in the originating request.

getContentType() - Method in class retrofit.Profiler.RequestInformation

Returns the content type header value of the originating request.

getHeaders() - Method in class retrofit.client.Request

Returns an unmodifiable list of headers, never null.

getHeaders() - Method in class retrofit.client.Response

An unmodifiable collection of headers.

getLogLevel() - Method in class retrofit.RestAdapter

The current logging level.

getMethod() - Method in class retrofit.client.Request

HTTP method verb.

getMethod() - Method in class retrofit.Profiler.RequestInformation

Returns the HTTP method of the originating request.

getName() - Method in class retrofit.ChangeableServer

Deprecated.

getName() - Method in class retrofit.client.Header

getName() - Method in interface retrofit.Endpoint

A name for differentiating between multiple API URLs.

getName() - Method in class retrofit.Server

Deprecated.

A name for differentiating between multiple API URLs.

getPartCount() - Method in class retrofit.mime.MultipartTypedOutput

getReason() - Method in class retrofit.client.Response

Status line reason phrase.

getRelativePath() - Method in class retrofit.Profiler.RequestInformation

Returns the path relative to the base URL to which the originating request was sent.

getResponse() - Method in exception retrofit.RetrofitError

Response object containing status code, headers, body, etc.

getStatus() - Method in class retrofit.client.Response

Status line code.

getTag() - Method in class retrofit.android.AndroidLog

getUrl() - Method in class retrofit.ChangeableServer

Deprecated.

getUrl() - Method in class retrofit.client.Request

Target URL.

getUrl() - Method in class retrofit.client.Response

Request URL.

getUrl() - Method in interface retrofit.Endpoint

The base API URL.

getUrl() - Method in exception retrofit.RetrofitError

The request URL which produced the error.

getUrl() - Method in class retrofit.Server

Deprecated.

The base API URL.

getValue() - Method in class retrofit.client.Header

GsonConverter - Class in retrofit.converter

A Converter which uses GSON for serialization and deserialization of entities.

GsonConverter(Gson) - Constructor for class retrofit.converter.GsonConverter

Create an instance using the supplied Gson object for conversion.

GsonConverter(Gson, String) - Constructor for class retrofit.converter.GsonConverter

Create an instance using the supplied Gson object for conversion.

H

handleError(RetrofitError) - Method in interface retrofit.ErrorHandler

Return a custom exception to be thrown for a RetrofitError.

hashCode() - Method in class retrofit.client.Header

hashCode() - Method in class retrofit.mime.TypedByteArray

hashCode() - Method in class retrofit.mime.TypedFile

HEAD - Annotation Type in retrofit.http

Make a HEAD request to a REST path relative to base URL.

Header - Class in retrofit.client

Represents an HTTP header name/value pair.

Header(String, String) - Constructor for class retrofit.client.Header

Header - Annotation Type in retrofit.http

Replaces the header with the the value of its target.

Headers - Annotation Type in retrofit.http

Adds headers literally supplied in the value.

httpError(String, Response, Converter, Type) - Static method in exception retrofit.RetrofitError

I

in() - Method in class retrofit.mime.TypedByteArray

in() - Method in class retrofit.mime.TypedFile

in() - Method in interface retrofit.mime.TypedInput

Read bytes as stream.

intercept(RequestInterceptor.RequestFacade) - Method in interface retrofit.RequestInterceptor

Called for every request.

isNetworkError() - Method in exception retrofit.RetrofitError

Whether or not this error was the result of a network error.

L

length() - Method in class retrofit.mime.FormUrlEncodedTypedOutput

length() - Method in class retrofit.mime.MultipartTypedOutput

length() - Method in class retrofit.mime.TypedByteArray

length() - Method in class retrofit.mime.TypedFile

length() - Method in interface retrofit.mime.TypedInput

Length in bytes.

length() - Method in interface retrofit.mime.TypedOutput

Length in bytes or -1 if unknown.

log(String) - Method in class retrofit.android.AndroidLog

log(String) - Method in interface retrofit.RestAdapter.Log

Log a debug message to the appropriate console.

log() - Method in enum retrofit.RestAdapter.LogLevel

logChunk(String) - Method in class retrofit.android.AndroidLog

Called one or more times for each call to AndroidLog.log(String).

M

MainThreadExecutor - Class in retrofit.android

Executor that runs tasks on Android's main thread.

MainThreadExecutor() - Constructor for class retrofit.android.MainThreadExecutor

mimeType() - Method in class retrofit.mime.FormUrlEncodedTypedOutput

mimeType() - Method in class retrofit.mime.MultipartTypedOutput

mimeType() - Method in class retrofit.mime.TypedByteArray

mimeType() - Method in class retrofit.mime.TypedFile

mimeType() - Method in interface retrofit.mime.TypedInput

Returns the mime type.

mimeType() - Method in interface retrofit.mime.TypedOutput

Returns the mime type.

MimeUtil - Class in retrofit.mime

moveTo(TypedFile) - Method in class retrofit.mime.TypedFile

Atomically moves the contents of this file to a new location.

Multipart - Annotation Type in retrofit.http

Denotes that the request body is multi-part.

MultipartTypedOutput - Class in retrofit.mime

MultipartTypedOutput() - Constructor for class retrofit.mime.MultipartTypedOutput

N

networkError(String, IOException) - Static method in exception retrofit.RetrofitError

newFixedEndpoint(String) - Static method in class retrofit.Endpoints

Create a server with the provided URL.

newFixedEndpoint(String, String) - Static method in class retrofit.Endpoints

Create an endpoint with the provided URL and name.

NONE - Static variable in interface retrofit.RequestInterceptor

A RequestInterceptor which does no modification of requests.

NONE - Static variable in interface retrofit.RestAdapter.Log

A RestAdapter.Log implementation which does not log anything.

O

OkClient - Class in retrofit.client

Retrofit client that uses OkHttp for communication.

OkClient() - Constructor for class retrofit.client.OkClient

OkClient(OkHttpClient) - Constructor for class retrofit.client.OkClient

openConnection(Request) - Method in class retrofit.client.OkClient

openConnection(Request) - Method in class retrofit.client.UrlConnectionClient

P

parseCharset(String) - Static method in class retrofit.mime.MimeUtil

Parse the MIME type from a Content-Type header value.

Part - Annotation Type in retrofit.http

Denotes a single part of a multi-part request.

PartMap - Annotation Type in retrofit.http

Denotes name and value parts of a multi-part request

PATCH - Annotation Type in retrofit.http

Make a PATCH request to a REST path relative to base URL.

Path - Annotation Type in retrofit.http

Named replacement in the URL path.

POST - Annotation Type in retrofit.http

Make a POST request to a REST path relative to base URL.

Profiler<T> - Interface in retrofit

A hook allowing clients to log HTTP method times and response status codes.

Profiler.RequestInformation - Class in retrofit

Information about the HTTP request.

PUT - Annotation Type in retrofit.http

Make a PUT request to a REST path relative to base URL.

Q

Query - Annotation Type in retrofit.http

Query parameter appended to the URL.

QueryMap - Annotation Type in retrofit.http

Query parameter keys and values appended to the URL.

R

Request - Class in retrofit.client

Encapsulates all of the information necessary to make an HTTP request.

Request(String, String, List<Header>, TypedOutput) - Constructor for class retrofit.client.Request

RequestInformation(String, String, String, long, String) - Constructor for class retrofit.Profiler.RequestInformation

RequestInterceptor - Interface in retrofit

Intercept every request before it is executed in order to add additional data.

RequestInterceptor.RequestFacade - Interface in retrofit

Response - Class in retrofit.client

An HTTP response.

Response(String, int, String, List<Header>, TypedInput) - Constructor for class retrofit.client.Response

Response(int, String, List<Header>, TypedInput) - Constructor for class retrofit.client.Response

Deprecated.

Use Response.Response(String, int, String, java.util.List, TypedInput). This class will be removed in version 1.5.

ResponseCallback - Class in retrofit

An extension of Callback which returns only Response object in Callback.success(Object, retrofit.client.Response) method.

ResponseCallback() - Constructor for class retrofit.ResponseCallback

RestAdapter - Class in retrofit

Adapts a Java interface to a REST API.

RestAdapter.Builder - Class in retrofit

Build a new RestAdapter.

RestAdapter.Log - Interface in retrofit

Simple logging abstraction for debug messages.

RestAdapter.LogLevel - Enum in retrofit

Controls the level of logging.

RestMethod - Annotation Type in retrofit.http

retrofit - package retrofit

Retrofit turns your REST API into a Java interface.

retrofit.android - package retrofit.android

retrofit.appengine - package retrofit.appengine

retrofit.client - package retrofit.client

retrofit.converter - package retrofit.converter

retrofit.http - package retrofit.http

Annotations for interface methods to control the HTTP request behavior.

retrofit.mime - package retrofit.mime

RetrofitError - Exception in retrofit

S

Server - Class in retrofit

Deprecated.

Use Endpoints.newFixedEndpoint(java.lang.String). This class will be removed in version 1.5.

Server(String) - Constructor for class retrofit.Server

Deprecated.

Create a server with the provided URL and default name.

Server(String, String) - Constructor for class retrofit.Server

Deprecated.

Create a server with the provided URL and name.

setClient(Client) - Method in class retrofit.RestAdapter.Builder

The HTTP client used for requests.

setClient(Client.Provider) - Method in class retrofit.RestAdapter.Builder

The HTTP client used for requests.

setConverter(Converter) - Method in class retrofit.RestAdapter.Builder

The converter used for serialization and deserialization of objects.

setEndpoint(String) - Method in class retrofit.RestAdapter.Builder

API endpoint URL.

setEndpoint(Endpoint) - Method in class retrofit.RestAdapter.Builder

API endpoint.

setErrorHandler(ErrorHandler) - Method in class retrofit.RestAdapter.Builder

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

setExecutors(Executor, Executor) - Method in class retrofit.RestAdapter.Builder

Executors used for asynchronous HTTP client downloads and callbacks.

setLog(RestAdapter.Log) - Method in class retrofit.RestAdapter.Builder

Configure debug logging mechanism.

setLogLevel(RestAdapter.LogLevel) - Method in class retrofit.RestAdapter.Builder

Change the level of logging.

setLogLevel(RestAdapter.LogLevel) - Method in class retrofit.RestAdapter

Change the level of logging.

setProfiler(Profiler) - Method in class retrofit.RestAdapter.Builder

Set the profiler used to measure requests.

setRequestInterceptor(RequestInterceptor) - Method in class retrofit.RestAdapter.Builder

A request interceptor for adding data to every request.

setServer(String) - Method in class retrofit.RestAdapter.Builder

Deprecated.

Use RestAdapter.Builder.setEndpoint(String) or RestAdapter.Builder.setEndpoint(Endpoint). This method will be removed in version 1.5.

setServer(Server) - Method in class retrofit.RestAdapter.Builder

Deprecated.

Use RestAdapter.Builder.setEndpoint(String) or RestAdapter.Builder.setEndpoint(Endpoint). This method will be removed in version 1.5.

success(T, Response) - Method in interface retrofit.Callback

Successful HTTP response.

success(Response, Response) - Method in class retrofit.ResponseCallback

success(Response) - Method in class retrofit.ResponseCallback

Successful HTTP response.

T

toBody(Object) - Method in interface retrofit.converter.Converter

Convert and object to an appropriate representation for HTTP transport.

toBody(Object) - Method in class retrofit.converter.GsonConverter

toString() - Method in class retrofit.client.Header

toString() - Method in class retrofit.mime.TypedFile

TypedByteArray - Class in retrofit.mime

Byte array and its mime type.

TypedByteArray(String, byte[]) - Constructor for class retrofit.mime.TypedByteArray

Constructs a new typed byte array.

TypedFile - Class in retrofit.mime

File and its mime type.

TypedFile(String, File) - Constructor for class retrofit.mime.TypedFile

Constructs a new typed file.

TypedInput - Interface in retrofit.mime

Binary data with an associated mime type.

TypedOutput - Interface in retrofit.mime

Binary data with an associated mime type.

TypedString - Class in retrofit.mime

TypedString(String) - Constructor for class retrofit.mime.TypedString

U

unexpectedError(String, Throwable) - Static method in exception retrofit.RetrofitError

update(String) - Method in class retrofit.ChangeableServer

Deprecated.

Update the URL returned by ChangeableServer.getUrl().

update(String, String) - Method in class retrofit.ChangeableServer

Deprecated.

Update the URL and name returned by ChangeableServer.getUrl() and ChangeableServer.getName(), respectively.

UrlConnectionClient - Class in retrofit.client

Retrofit client that uses HttpURLConnection for communication.

UrlConnectionClient() - Constructor for class retrofit.client.UrlConnectionClient

UrlFetchClient - Class in retrofit.appengine

A Client for Google AppEngine's which uses its URLFetchService.

UrlFetchClient() - Constructor for class retrofit.appengine.UrlFetchClient

UrlFetchClient(URLFetchService) - Constructor for class retrofit.appengine.UrlFetchClient

V

valueOf(String) - Static method in enum retrofit.RestAdapter.LogLevel

Returns the enum constant of this type with the specified name.

values() - Static method in enum retrofit.RestAdapter.LogLevel

Returns an array containing the constants of this enum type, in the order they are declared.

W

writeTo(OutputStream) - Method in class retrofit.mime.FormUrlEncodedTypedOutput

writeTo(OutputStream) - Method in class retrofit.mime.MultipartTypedOutput

writeTo(OutputStream) - Method in class retrofit.mime.TypedByteArray

writeTo(OutputStream) - Method in class retrofit.mime.TypedFile

writeTo(OutputStream) - Method in interface retrofit.mime.TypedOutput

Writes these bytes to the given output stream.

A B C D E F G H I L M N O P Q R S T U V W