com.box.androidsdk.content.requests

Class BoxRequestBatch

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxResponseBatch,BoxRequestBatch>

com.box.androidsdk.content.requests.BoxRequestBatch

All Implemented Interfaces:

java.io.Serializable

public class BoxRequestBatch
extends BoxRequest<BoxResponseBatch,BoxRequestBatch>

Batch request class that allows the ability to send multiple BoxRequests through an executor and return a batch response object that contains all of the response information for each individual request Requests will run in parallel if Executor is set by caller otherwise requests will run sequentially.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<BoxRequest>	mRequests

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
BoxRequestBatch() Initializes a new BoxRequestBatch

Method Summary

Modifier and Type	Method and Description
BoxRequestBatch	addRequest(BoxRequest request) Adds a BoxRequest to the batch
BoxResponseBatch	onSend() Synchronously make the request to Box and handle the response appropriately.
BoxRequestBatch	setExecutor(java.util.concurrent.ExecutorService executor) Requests will run in parallel if Executor is set by caller otherwise requests will run sequentially.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

mRequests

protected java.util.ArrayList<BoxRequest> mRequests

Constructor Detail

BoxRequestBatch

public BoxRequestBatch()

Initializes a new BoxRequestBatch

Method Detail

setExecutor

public BoxRequestBatch setExecutor(java.util.concurrent.ExecutorService executor)

Requests will run in parallel if Executor is set by caller otherwise requests will run sequentially.

Parameters:

executor - executor used to execute this request in parallel

Returns:

current request

addRequest

public BoxRequestBatch addRequest(BoxRequest request)

Adds a BoxRequest to the batch

Parameters:

request - the BoxRequest to add

Returns:

the batch request

onSend

public BoxResponseBatch onSend()
                        throws BoxException

Description copied from class: BoxRequest

Synchronously make the request to Box and handle the response appropriately.

Overrides:

onSend in class BoxRequest<BoxResponseBatch,BoxRequestBatch>

Returns:

the expected BoxObject if the request is successful.

Throws:

BoxException - thrown if there was a problem with handling the request.