Package com.google.gerrit.extensions.restapi

Class Response<T>

java.lang.Object

com.google.gerrit.extensions.restapi.Response<T>

Direct Known Subclasses:

Response.Accepted, Response.Redirect

public abstract class Response<T>
extends Object

Special return value to mean specific HTTP status codes in a REST API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Response.Accepted	Accepted as task for asynchronous execution.
static final class	Response.Redirect	An HTTP redirect to another location.

Constructor Summary

Constructors

Constructor	Description
Response()

Method Summary

Modifier and Type	Method	Description
static Response.Accepted	accepted(String location)	HTTP 202 Accepted: accepted as background task.
abstract CacheControl	caching()
abstract Response<T>	caching(CacheControl c)
static Response<String>	created()	HTTP 201 Created: with empty value.
static <T> Response<T>	created(T value)	HTTP 201 Created: typically used when a new resource is made.
abstract com.google.common.collect.ImmutableMultimap<String,String>	headers()
abstract boolean	isNone()
static <T> Response<T>	none()	HTTP 204 No Content: typically used when the resource is deleted.
static Response<String>	ok()	HTTP 200 OK: with empty value.
static <T> Response<T>	ok(T value)	HTTP 200 OK: pointless wrapper for type safety.
static <T> Response<T>	ok(T value, com.google.common.collect.ImmutableMultimap<String,String> headers)
static Response.Redirect	redirect(String location)	HTTP 302 Found: temporary redirect to another URL.
abstract int	statusCode()
abstract String	toString()
static <T> T	unwrap(T obj)
abstract T	value()
static <T> Response<T>	withMustRevalidate(T value)	HTTP 200 OK: with forced revalidation of cache.
static <T> Response<T>	withStatusCode(int statusCode, T value)	Arbitrary status code with wrapped result.

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response()

Method Details

ok

public static <T> Response<T> ok(T value)

HTTP 200 OK: pointless wrapper for type safety.

ok

public static <T> Response<T> ok(T value,
 com.google.common.collect.ImmutableMultimap<String,String> headers)

ok

public static Response<String> ok()

HTTP 200 OK: with empty value.

withMustRevalidate

public static <T> Response<T> withMustRevalidate(T value)

HTTP 200 OK: with forced revalidation of cache.

created

public static <T> Response<T> created(T value)

HTTP 201 Created: typically used when a new resource is made.

created

public static Response<String> created()

HTTP 201 Created: with empty value.

accepted

public static Response.Accepted accepted(String location)

HTTP 202 Accepted: accepted as background task.

none

public static <T> Response<T> none()

HTTP 204 No Content: typically used when the resource is deleted.

redirect

public static Response.Redirect redirect(String location)

HTTP 302 Found: temporary redirect to another URL.

withStatusCode

public static <T> Response<T> withStatusCode(int statusCode,
 T value)

Arbitrary status code with wrapped result.

unwrap

public static <T> T unwrap(T obj)

isNone

public abstract boolean isNone()

statusCode

public abstract int statusCode()

value

public abstract T value()

headers

public abstract com.google.common.collect.ImmutableMultimap<String,String> headers()

caching

public abstract CacheControl caching()

caching

@CanIgnoreReturnValue
public abstract Response<T> caching(CacheControl c)

toString

public abstract String toString()

Overrides:

toString in class Object