com.android.volley.request

Class GsonRequest<T>

java.lang.Object

com.android.volley.Request<T>

com.android.volley.request.GsonRequest<T>

All Implemented Interfaces:

java.lang.Comparable<Request<T>>

public class GsonRequest<T>
extends Request<T>

Volley adapter for JSON requests that will be parsed into Java objects by Gson.

Nested Class Summary

Nested classes/interfaces inherited from class com.android.volley.Request

Request.Method, Request.Priority

Constructor Summary

Constructors

Constructor and Description
GsonRequest(int type, java.lang.String url, java.lang.Class<T> clazz, java.util.Map<java.lang.String,java.lang.String> headers, java.util.Map<java.lang.String,java.lang.String> params, Response.Listener<T> listener, Response.ErrorListener errorListener) Make a request and return a parsed object from JSON.
GsonRequest(java.lang.String url, java.lang.Class<T> clazz, java.util.Map<java.lang.String,java.lang.String> headers, Response.Listener<T> listener, Response.ErrorListener errorListener) Make a GET request and return a parsed object from JSON.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
java.lang.Class<T>	getClazz()
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Returns a list of extra HTTP headers to go along with this request.
protected java.util.Map<java.lang.String,java.lang.String>	getParams() Returns a Map of parameters to be used for a POST or PUT request.
protected Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.

Methods inherited from class com.android.volley.Request

addMarker, cancel, compareTo, deliverError, getBody, getBodyContentType, getCacheEntry, getCacheKey, getEncodedUrlParams, getErrorListener, getMethod, getParamsEncoding, getPostBody, getPostBodyContentType, getPostParams, getPostParamsEncoding, getPriority, getRetryPolicy, getSequence, getTag, getTimeoutMs, getTrafficStatsTag, getUrl, hasHadResponseDelivered, isCanceled, markDelivered, overridePatch, parseNetworkError, setCacheEntry, setHeaders, setParams, setPriority, setRequestQueue, setRetryPolicy, setSequence, setShouldCache, setTag, shouldCache, shouldOverridePatch, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GsonRequest

public GsonRequest(java.lang.String url,
           java.lang.Class<T> clazz,
           java.util.Map<java.lang.String,java.lang.String> headers,
           Response.Listener<T> listener,
           Response.ErrorListener errorListener)

Make a GET request and return a parsed object from JSON.

Parameters:

url - URL of the request to make

clazz - Relevant class object, for Gson's reflection

headers - Map of request headers

GsonRequest

public GsonRequest(int type,
           java.lang.String url,
           java.lang.Class<T> clazz,
           java.util.Map<java.lang.String,java.lang.String> headers,
           java.util.Map<java.lang.String,java.lang.String> params,
           Response.Listener<T> listener,
           Response.ErrorListener errorListener)

Make a request and return a parsed object from JSON.

Parameters:

url - URL of the request to make

clazz - Relevant class object, for Gson's reflection

headers - Map of request headers

Method Detail

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()
                                                            throws AuthFailureError

Description copied from class: Request

Returns a list of extra HTTP headers to go along with this request. Can throw AuthFailureError as authentication may be required to provide these values.

Overrides:

getHeaders in class Request<T>

Throws:

AuthFailureError - In the event of auth failure

getParams

protected java.util.Map<java.lang.String,java.lang.String> getParams()
                                                              throws AuthFailureError

Description copied from class: Request

Returns a Map of parameters to be used for a POST or PUT request. Can throw AuthFailureError as authentication may be required to provide these values.

Note that you can directly override Request.getBody() for custom data.

Overrides:

getParams in class Request<T>

Throws:

AuthFailureError - in the event of auth failure

deliverResponse

protected void deliverResponse(T response)

Description copied from class: Request

Subclasses must implement this to perform delivery of the parsed response to their listeners. The given response is guaranteed to be non-null; responses that fail to parse are not delivered.

Specified by:

deliverResponse in class Request<T>

Parameters:

response - The parsed response returned by Request.parseNetworkResponse(NetworkResponse)

getClazz

public final java.lang.Class<T> getClazz()

parseNetworkResponse

protected Response<T> parseNetworkResponse(NetworkResponse response)

Description copied from class: Request

Subclasses must implement this to parse the raw network response and return an appropriate response type. This method will be called from a worker thread. The response will not be delivered if you return null.

Specified by:

parseNetworkResponse in class Request<T>

Parameters:

response - Response from the network

Returns:

The parsed response, or null in the case of an error