com.scvngr.levelup.core.net

Class AbstractResponse<T>

java.lang.Object

com.scvngr.levelup.core.net.AbstractResponse<T>

Type Parameters:

T - the response data type.

Direct Known Subclasses:

BufferedResponse, StreamingResponse

@NotThreadSafe
 @LevelUpApi(contract=PUBLIC)
public abstract class AbstractResponse<T>
extends Object

Object which represents an HTTP response.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResponse(Exception error) Constructor for an error response.
protected	AbstractResponse(int statusCode, Exception error)
protected	AbstractResponse(int statusCode, Map<String,List<String>> httpHeaders, Exception error)

Method Summary

Modifier and Type	Method and Description
abstract T	getData()
Exception	getError()
String	getHttpHeader(String headerField) Retrieves the desired HTTP header.
protected Map<String,List<String>>	getHttpHeaders()
int	getHttpStatusCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResponse

protected AbstractResponse(Exception error)

Constructor for an error response.

Parameters:

error - any exception that was thrown during the request.

AbstractResponse

protected AbstractResponse(int statusCode,
                           Exception error)

Parameters:

statusCode - the HTTP status code.

error - the Exception that was thrown during the request or null if there was no error.

AbstractResponse

protected AbstractResponse(int statusCode,
                           Map<String,List<String>> httpHeaders,
                           Exception error)

Parameters:

statusCode - the HTTP status code of the response.

httpHeaders - the HTTP headers included in the response. This must be an unmodifiable map, for example one wrapped using Collections.unmodifiableMap(Map).

error - the Exception that was thrown during the request or null if there was no error.

Method Detail

getData

public abstract T getData()

Returns:

the data sent from the server in this response.

getHttpStatusCode

public final int getHttpStatusCode()

Returns:

HTTP status code passed back from the server (if any).

getHttpHeader

public final String getHttpHeader(String headerField)

Retrieves the desired HTTP header. If multiple headers of the same key are present, this retrieves the first one.

Parameters:

headerField - the HTTP header field (the key). This value must be be normalized to First-Letter-Caps.

Returns:

the value of the header or null if no header is present.

getHttpHeaders

protected Map<String,List<String>> getHttpHeaders()

Returns:

the HTTP headers.

getError

public Exception getError()

Returns:

the Exception that was thrown during a request.

toString

public String toString()

Overrides:

toString in class Object