com.hannesdorfmann.httpkit.response

Class HttpResponse<T>

java.lang.Object

com.hannesdorfmann.httpkit.response.HttpResponse<T>

Type Parameters:

T - The type of the parsed object. You can say, this is the result of http request

public class HttpResponse<T>
extends Object

This object wraps the result of an http request

Author:

Hannes Dorfmann

Constructor Summary

Constructors

Constructor and Description
HttpResponse()
HttpResponse(HttpRequest request, int httpStatusCode, T parsedResult)
HttpResponse(int httpStatusCode, T parsedResult)

Method Summary

Methods

Modifier and Type	Method and Description
long	getExpirationTimestamp() Get the timestamp in utc timezone, when the value of this response expires
HttpRequest	getHttpRequest() Get the HttpRequest that has been processed to generate this HttpResponse
int	getResponseCode() Get the http status code of the http response
T	getValue() Get the parsed Result
boolean	isFromCache() Returns true, if the response has been retrieved from the cache
boolean	isFromCacheBecauseOffline()
boolean	isResponseOkOrNotModified() Checks if the response status code of the http request was 200 or 304, which means that the http request has returned successful or the result has been retrieved successfully from the cache
void	setExpirationTimestamp(long utcTimestamp) Set the timestamp when the value of this response expires
void	setFromCache(boolean fromCache)
void	setFromCacheBecauseOffline(boolean smartphoneIsOffline) Set this to true, if the response comes from the cache, because the smartphone is offline
void	setHttpRequest(HttpRequest httpRequest)
void	setResonseCode(int statusCode) Set the status code of the http response
void	setValue(T parsedResult) Set the parsed Result of the http response
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponse

public HttpResponse()

HttpResponse

public HttpResponse(int httpStatusCode,
            T parsedResult)

HttpResponse

public HttpResponse(HttpRequest request,
            int httpStatusCode,
            T parsedResult)

Method Detail

setResonseCode

public void setResonseCode(int statusCode)

Set the status code of the http response

Parameters:

statusCode -

setValue

public void setValue(T parsedResult)

Set the parsed Result of the http response

Parameters:

parsedResult -

getResponseCode

public int getResponseCode()

Get the http status code of the http response

Returns:

getValue

public T getValue()

Get the parsed Result

Returns:

isResponseOkOrNotModified

public boolean isResponseOkOrNotModified()

Checks if the response status code of the http request was 200 or 304, which means that the http request has returned successful or the result has been retrieved successfully from the cache

Returns:

setFromCache

public void setFromCache(boolean fromCache)

isFromCache

public boolean isFromCache()

Returns true, if the response has been retrieved from the cache

isFromCacheBecauseOffline

public boolean isFromCacheBecauseOffline()

Returns:

true, if the response is from cache, because the smartphone is offline

setFromCacheBecauseOffline

public void setFromCacheBecauseOffline(boolean smartphoneIsOffline)

Set this to true, if the response comes from the cache, because the smartphone is offline

Parameters:

smartphoneIsOffline -

toString

public String toString()

Overrides:

toString in class Object

getHttpRequest

public HttpRequest getHttpRequest()

Get the HttpRequest that has been processed to generate this HttpResponse

Returns:

setHttpRequest

public void setHttpRequest(HttpRequest httpRequest)

Parameters:

httpRequest -

See Also:

getHttpRequest()

setExpirationTimestamp

public void setExpirationTimestamp(long utcTimestamp)

Set the timestamp when the value of this response expires

Parameters:

utcTimestamp - in milliseconds

getExpirationTimestamp

public long getExpirationTimestamp()

Get the timestamp in utc timezone, when the value of this response expires

Returns:

a UTC timestamp in milliseconds or 0 if unknown or the response value is not cachable