public class

ImageRequest

extends Request<T>

java.lang.Object
↳	com.android.volley.Request<T>
	↳	com.android.volley.toolbox.ImageRequest

Class Overview

A canned request for getting an image at a given URL and calling back with a decoded Bitmap.

Summary

Constants
float	DEFAULT_IMAGE_BACKOFF_MULT	Default backoff multiplier for image requests
int	DEFAULT_IMAGE_MAX_RETRIES	Default number of retries for image requests
int	DEFAULT_IMAGE_TIMEOUT_MS	Socket timeout in milliseconds for image requests

Public Constructors
	ImageRequest(String url, Listener<Bitmap> listener, int maxWidth, int maxHeight, ImageView.ScaleType scaleType, Bitmap.Config decodeConfig, Response.ErrorListener errorListener) Creates a new image request, decoding to a maximum specified width and height.
	ImageRequest(String url, Listener<Bitmap> listener, int maxWidth, int maxHeight, Bitmap.Config decodeConfig, Response.ErrorListener errorListener) For API compatibility with the pre-ScaleType variant of the constructor.

Public Methods
Request.Priority	getPriority() Returns the `Request.Priority` of this request; `NORMAL` by default.

Protected Methods
void	deliverResponse(Bitmap response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
Response<Bitmap>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.

[Expand]

Inherited Methods

From class com.android.volley.Request

void	addMarker(String tag) Adds an event to this request's event log; for debugging.
void	cancel() Mark this request as canceled.
int	compareTo(Request<T> other) Our comparator sorts from high to low priority, and secondarily by sequence number to provide FIFO ordering.
void	deliverError(VolleyError error) Delivers error message to the ErrorListener that the Request was initialized with.
abstract void	deliverResponse(T response) Subclasses must implement this to perform delivery of the parsed response to their listeners.
byte[]	getBody() Returns the raw POST or PUT body to be sent.
String	getBodyContentType() Returns the content type of the POST or PUT body.
Cache.Entry	getCacheEntry() Returns the annotated cache entry, or null if there isn't one.
String	getCacheKey() Returns the cache key for this request.
Response.ErrorListener	getErrorListener()
Map<String, String>	getHeaders() Returns a list of extra HTTP headers to go along with this request.
int	getMethod() Return the method for this request.
Map<String, String>	getParams() Returns a Map of parameters to be used for a POST or PUT request.
String	getParamsEncoding() Returns which encoding should be used when converting POST or PUT parameters returned by `getParams()` into a raw POST or PUT body.
byte[]	getPostBody() This method is deprecated. Use `getBody()` instead.
String	getPostBodyContentType() This method is deprecated. Use `getBodyContentType()` instead.
Map<String, String>	getPostParams() This method is deprecated. Use `getParams()` instead.
String	getPostParamsEncoding() This method is deprecated. Use `getParamsEncoding()` instead.
Request.Priority	getPriority() Returns the `Request.Priority` of this request; `NORMAL` by default.
RetryPolicy	getRetryPolicy() Returns the retry policy that should be used for this request.
final int	getSequence() Returns the sequence number of this request.
Object	getTag() Returns this request's tag.
final int	getTimeoutMs() Returns the socket timeout in milliseconds per retry attempt.
int	getTrafficStatsTag()
String	getUrl() Returns the URL of this request.
boolean	hasHadResponseDelivered() Returns true if this request has had a response delivered for it.
boolean	isCanceled() Returns true if this request has been canceled.
void	markDelivered() Mark this request as having a response delivered on it.
VolleyError	parseNetworkError(VolleyError volleyError) Subclasses can override this method to parse 'networkError' and return a more specific error.
abstract Response<T>	parseNetworkResponse(NetworkResponse response) Subclasses must implement this to parse the raw network response and return an appropriate response type.
Request<?>	setCacheEntry(Cache.Entry entry) Annotates this request with an entry retrieved for it from cache.
Request<?>	setRequestQueue(RequestQueue requestQueue) Associates this request with the given queue.
Request<?>	setRetryPolicy(RetryPolicy retryPolicy) Sets the retry policy for this request.
final Request<?>	setSequence(int sequence) Sets the sequence number of this request.
final Request<?>	setShouldCache(boolean shouldCache) Set whether or not responses to this request should be cached.
Request<?>	setTag(Object tag) Set a tag on this request.
final boolean	shouldCache() Returns true if responses to this request should be cached.
String	toString()

From class java.lang.Object

From interface java.lang.Comparable

Constants

public static final float DEFAULT_IMAGE_BACKOFF_MULT

Default backoff multiplier for image requests

Constant Value: 2.0

public static final int DEFAULT_IMAGE_MAX_RETRIES

Default number of retries for image requests

Constant Value: 2 (0x00000002)

public static final int DEFAULT_IMAGE_TIMEOUT_MS

Socket timeout in milliseconds for image requests

Constant Value: 1000 (0x000003e8)

Public Constructors

public ImageRequest (String url, Listener<Bitmap> listener, int maxWidth, int maxHeight, ImageView.ScaleType scaleType, Bitmap.Config decodeConfig, Response.ErrorListener errorListener)

Creates a new image request, decoding to a maximum specified width and height. If both width and height are zero, the image will be decoded to its natural size. If one of the two is nonzero, that dimension will be clamped and the other one will be set to preserve the image's aspect ratio. If both width and height are nonzero, the image will be decoded to be fit in the rectangle of dimensions width x height while keeping its aspect ratio.

Parameters

url	URL of the image
listener	Listener to receive the decoded bitmap
maxWidth	Maximum width to decode this bitmap to, or zero for none
maxHeight	Maximum height to decode this bitmap to, or zero for none
scaleType	The ImageViews ScaleType used to calculate the needed image size.
decodeConfig	Format to decode the bitmap to
errorListener	Error listener, or null to ignore errors

public ImageRequest (String url, Listener<Bitmap> listener, int maxWidth, int maxHeight, Bitmap.Config decodeConfig, Response.ErrorListener errorListener)

For API compatibility with the pre-ScaleType variant of the constructor. Equivalent to the normal constructor with ScaleType.CENTER_INSIDE.

Public Methods

public Request.Priority getPriority ()

Returns the Request.Priority of this request; NORMAL by default.

Protected Methods

protected void deliverResponse (Bitmap response)

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.

Parameters

response	The parsed response returned by `parseNetworkResponse(NetworkResponse)`

protected Response<Bitmap> parseNetworkResponse (NetworkResponse response)

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.

Parameters

response	Response from the network

Returns

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

Interfaces

Classes

ImageRequest

Class Overview

Summary

Constants

public static final float DEFAULT_IMAGE_BACKOFF_MULT

public static final int DEFAULT_IMAGE_MAX_RETRIES

public static final int DEFAULT_IMAGE_TIMEOUT_MS

Public Constructors

public ImageRequest (String url, Listener<Bitmap> listener, int maxWidth, int maxHeight, ImageView.ScaleType scaleType, Bitmap.Config decodeConfig, Response.ErrorListener errorListener)

Parameters

public ImageRequest (String url, Listener<Bitmap> listener, int maxWidth, int maxHeight, Bitmap.Config decodeConfig, Response.ErrorListener errorListener)

Public Methods

public Request.Priority getPriority ()

Protected Methods

protected void deliverResponse (Bitmap response)

Parameters

protected Response<Bitmap> parseNetworkResponse (NetworkResponse response)

Parameters

Returns