Batch

Handles a batch of PendingResult items. Callbacks can be added and you can block to wait for all items in the batch to complete like any other PendingResult item. A Batch can also be canceled if the results are no longer needed. In this case, the onBatchComplete callback will never be triggered.

The results can be taken either from the underlying PendingResults or via take(BatchResultToken) but not both.

Nested Class Summary

class Batch.Builder Builder for Batch objects.

Field Summary

protected final WeakReference<GoogleApiClient> mApiClient This reference will never be null so long as the GoogleApiClient is connected.

Public Method Summary

final R extends Result	await() Blocks until the task is completed.
final R extends Result	await(long time, TimeUnit units) Blocks until the task is completed or has timed out waiting for the result.
void	cancel() Requests that the batch be canceled.
void	clearResultCallback()
BatchResult	createFailedResult(Status status) Creates a result of type `<R>` that represents a failure with the specified `Status`.
boolean	isCanceled() Indicates whether the pending result has been canceled either due to calling `disconnect()` or calling `cancel()` directly on the pending result or an enclosing `Batch`.
final void	setResultCallback(ResultCallback<? super R extends Result> callback) Set the callback here if you want the result to be delivered via a callback when the result is ready.
final void	setResultCallback(ResultCallback<? super R extends Result> callback, long time, TimeUnit units) Set the callback here if you want the result to be delivered via a callback when the result is ready or has timed out waiting for the result.

Inherited Method Summary

From class com.google.android.gms.common.api.PendingResult

abstract R	await() Blocks until the task is completed.
abstract R	await(long time, TimeUnit units) Blocks until the task is completed or has timed out waiting for the result.
abstract void	cancel() Requests that the PendingResult be canceled.
abstract boolean	isCanceled() Indicates whether the pending result has been canceled either due to calling `disconnect()` or calling `cancel()` directly on the pending result or an enclosing `Batch`.
abstract void	setResultCallback(ResultCallback<? super R> callback) Set the callback here if you want the result to be delivered via a callback when the result is ready.
abstract void	setResultCallback(ResultCallback<? super R> callback, long time, TimeUnit units) Set the callback here if you want the result to be delivered via a callback when the result is ready or has timed out waiting for the result.
<S extends Result> TransformedResult<S>	then(ResultTransform<? super R, ? extends S> transform) Transforms the result by making another API call.

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Fields

protected final WeakReference<GoogleApiClient> mApiClient

This reference will never be null so long as the GoogleApiClient is connected. It needs to be weak so that PendingResults don't pin disconnected GACs due to binder references to the PendingResults.

Public Methods

public final R extends Result await ()

Blocks until the task is completed. This is not allowed on the UI thread. The returned result object can have an additional failure mode of INTERRUPTED.

public final R extends Result await (long time, TimeUnit units)

Blocks until the task is completed or has timed out waiting for the result. This is not allowed on the UI thread. The returned result object can have an additional failure mode of either INTERRUPTED or TIMEOUT.

public void cancel ()

Requests that the batch be canceled. Cancels all underlying PendingResults.

onResult(Result) will never be called, await() will return a failed result with status CANCELED.

public void clearResultCallback ()

public BatchResult createFailedResult (Status status)

Creates a result of type <R> that represents a failure with the specified Status.

public boolean isCanceled ()

Indicates whether the pending result has been canceled either due to calling disconnect() or calling cancel() directly on the pending result or an enclosing Batch.

public final void setResultCallback (ResultCallback<? super R extends Result> callback)

Set the callback here if you want the result to be delivered via a callback when the result is ready.

public final void setResultCallback (ResultCallback<? super R extends Result> callback, long time, TimeUnit units)

Set the callback here if you want the result to be delivered via a callback when the result is ready or has timed out waiting for the result. The returned result object can have an additional failure mode of TIMEOUT.