com.android.volley.request

Class DownloadRequest

java.lang.Object

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

com.android.volley.request.DownloadRequest

All Implemented Interfaces:

Response.ProgressListener, java.lang.Comparable<Request<java.lang.String>>

public class DownloadRequest
extends Request<java.lang.String>
implements Response.ProgressListener

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.android.volley.Request

Request.Method, Request.Priority

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	deliverResponse(java.lang.String response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
void	onProgress(long transferredBytes, long totalSize) Callback method thats called on each byte transfer.
protected Response<java.lang.String>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.
void	setOnProgressListener(Response.ProgressListener listener) Set listener for tracking download progress

Methods inherited from class com.android.volley.Request

addMarker, cancel, compareTo, deliverError, getBody, getBodyContentType, getCacheEntry, getCacheKey, getEncodedUrlParams, getErrorListener, getHeaders, getMethod, getParams, 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

DownloadRequest

public DownloadRequest(java.lang.String url,
               java.lang.String download_path,
               Response.Listener<java.lang.String> listener,
               Response.ErrorListener errorListener)

Creates a new request with the given method.

Parameters:

url - URL to fetch the string at

download_path - path to save the file to

listener - Listener to receive the String response

errorListener - Error listener, or null to ignore errors

Method Detail

setOnProgressListener

public void setOnProgressListener(Response.ProgressListener listener)

Set listener for tracking download progress

Parameters:

listener -

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

onProgress

public void onProgress(long transferredBytes,
              long totalSize)

Description copied from interface: Response.ProgressListener

Callback method thats called on each byte transfer.

Specified by:

onProgress in interface Response.ProgressListener