com.mopub.volley.toolbox

Class StringRequest

java.lang.Object

com.mopub.volley.Request<java.lang.String>

com.mopub.volley.toolbox.StringRequest

All Implemented Interfaces:

java.lang.Comparable<Request<java.lang.String>>

public class StringRequest
extends Request<java.lang.String>

A canned request for retrieving the response body at a given URL as a String.

Nested Class Summary

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

Request.Method, Request.Priority

Constructor Summary

Constructors

Constructor and Description
StringRequest(int method, java.lang.String url, Response.Listener<java.lang.String> listener, Response.ErrorListener errorListener) Creates a new request with the given method.
StringRequest(java.lang.String url, Response.Listener<java.lang.String> listener, Response.ErrorListener errorListener) Creates a new GET request.

Method Summary

Modifier and Type	Method and Description
void	cancel() Mark this request as canceled.
protected void	deliverResponse(java.lang.String response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
protected Response<java.lang.String>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.

Methods inherited from class com.mopub.volley.Request

addMarker, compareTo, deliverError, getBody, getBodyContentType, getCacheEntry, getCacheKey, getErrorListener, getHeaders, getMethod, getParams, getParamsEncoding, getPostBody, getPostBodyContentType, getPostParams, getPostParamsEncoding, getPriority, getRetryPolicy, getSequence, getTag, getTimeoutMs, getTrafficStatsTag, getUrl, hasHadResponseDelivered, isCanceled, markDelivered, parseNetworkError, setCacheEntry, setRequestQueue, setRetryPolicy, setSequence, setShouldCache, setShouldRetryServerErrors, setTag, shouldCache, shouldRetryServerErrors, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringRequest

public StringRequest(int method,
                     java.lang.String url,
                     Response.Listener<java.lang.String> listener,
                     @Nullable
                     Response.ErrorListener errorListener)

Creates a new request with the given method.

Parameters:

method - the request Method to use

url - URL to fetch the string at

listener - Listener to receive the String response

errorListener - Error listener, or null to ignore errors

StringRequest

public StringRequest(java.lang.String url,
                     Response.Listener<java.lang.String> listener,
                     @Nullable
                     Response.ErrorListener errorListener)

Creates a new GET request.

Parameters:

url - URL to fetch the string at

listener - Listener to receive the String response

errorListener - Error listener, or null to ignore errors

Method Detail

cancel

public void cancel()

Description copied from class: Request

Mark this request as canceled.

No callback will be delivered as long as either:

• This method is called on the same thread as the ResponseDelivery is running on. By default, this is the main thread.
• The request subclass being used overrides cancel() and ensures that it does not invoke the listener in Request.deliverResponse(T) after cancel() has been called in a thread-safe manner.

There are no guarantees if both of these conditions aren't met.

Overrides:

cancel in class Request<java.lang.String>

deliverResponse

protected void deliverResponse(java.lang.String 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<java.lang.String>

Parameters:

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

parseNetworkResponse

protected Response<java.lang.String> 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<java.lang.String>

Parameters:

response - Response from the network

Returns:

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