StorageTask

public abstract class StorageTask extends ControllableTask<ResultT extends StorageTask.ProvideError>

Known Direct Subclasses

FileDownloadTask, StreamDownloadTask, UploadTask

A controllable Task that has a synchronized state machine.

Nested Class Summary

interface	StorageTask.ProvideError		An object that returns an exception.
class	StorageTask.SnapshotBase		Base class for state.

Field Summary

protected final Object syncObject

Protected Constructor Summary

StorageTask()

Public Method Summary

StorageTask<ResultT>	addOnCanceledListener(OnCanceledListener listener) Adds a listener that is called if the Task is canceled.
StorageTask<ResultT>	addOnCanceledListener(Executor executor, OnCanceledListener listener) Adds a listener that is called if the Task is canceled.
StorageTask<ResultT>	addOnCanceledListener(Activity activity, OnCanceledListener listener) Adds an Activity-scoped listener that is called if the Task is canceled.
StorageTask<ResultT>	addOnCompleteListener(Activity activity, OnCompleteListener<ResultT> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<ResultT>	addOnCompleteListener(OnCompleteListener<ResultT> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<ResultT>	addOnCompleteListener(Executor executor, OnCompleteListener<ResultT> listener) Adds a listener that is called when the Task succeeds or fails.
StorageTask<ResultT>	addOnFailureListener(Activity activity, OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<ResultT>	addOnFailureListener(OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<ResultT>	addOnFailureListener(Executor executor, OnFailureListener listener) Adds a listener that is called if the Task fails.
StorageTask<ResultT>	addOnPausedListener(Executor executor, OnPausedListener<? super ResultT> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<ResultT>	addOnPausedListener(OnPausedListener<? super ResultT> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<ResultT>	addOnPausedListener(Activity activity, OnPausedListener<? super ResultT> listener) Adds a listener that is called when the Task becomes paused.
StorageTask<ResultT>	addOnProgressListener(OnProgressListener<? super ResultT> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<ResultT>	addOnProgressListener(Activity activity, OnProgressListener<? super ResultT> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<ResultT>	addOnProgressListener(Executor executor, OnProgressListener<? super ResultT> listener) Adds a listener that is called periodically while the ControllableTask executes.
StorageTask<ResultT>	addOnSuccessListener(OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
StorageTask<ResultT>	addOnSuccessListener(Executor executor, OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
StorageTask<ResultT>	addOnSuccessListener(Activity activity, OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
boolean	cancel() Attempts to cancel the task.
<ContinuationResultT> Task<ContinuationResultT>	continueWith(Continuation<ResultT, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<ContinuationResultT> Task<ContinuationResultT>	continueWith(Executor executor, Continuation<ResultT, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<ContinuationResultT> Task<ContinuationResultT>	continueWithTask(Executor executor, Continuation<ResultT, Task<ContinuationResultT>> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
<ContinuationResultT> Task<ContinuationResultT>	continueWithTask(Continuation<ResultT, Task<ContinuationResultT>> continuation) Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
Exception	getException() Returns the exception that caused the Task to fail.
ResultT	getResult() Gets the result of the Task, if it has already completed.
<X extends Throwable> ResultT	getResult(Class<X> exceptionType) Gets the result of the Task, if it has already completed.
ResultT	getSnapshot() Returns the current state of the task.
boolean	isCanceled() Returns `true` if the task has been canceled.
boolean	isComplete() Returns `true` if the Task is complete; `false` otherwise.
boolean	isInProgress() Returns `true` if the task is currently running.
boolean	isPaused() Returns `true` if the task has been paused.
boolean	isSuccessful() Returns `true` if the Task has completed successfully; `false` otherwise.
<ContinuationResultT> Task<ContinuationResultT>	onSuccessTask(SuccessContinuation<ResultT, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
<ContinuationResultT> Task<ContinuationResultT>	onSuccessTask(Executor executor, SuccessContinuation<ResultT, ContinuationResultT> continuation) Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully.
boolean	pause() Attempts to pause the task.
StorageTask<ResultT>	removeOnCanceledListener(OnCanceledListener listener) Removes a listener.
StorageTask<ResultT>	removeOnCompleteListener(OnCompleteListener<ResultT> listener) Removes a listener.
StorageTask<ResultT>	removeOnFailureListener(OnFailureListener listener) Removes a listener.
StorageTask<ResultT>	removeOnPausedListener(OnPausedListener<? super ResultT> listener) Removes a listener.
StorageTask<ResultT>	removeOnProgressListener(OnProgressListener<? super ResultT> listener) Removes a listener.
StorageTask<ResultT>	removeOnSuccessListener(OnSuccessListener<? super ResultT> listener) Removes a listener.
boolean	resume() Attempts to resume a paused task.

Protected Method Summary

void	onCanceled()
void	onFailure()
void	onPaused()
void	onProgress()
void	onQueued()
void	onSuccess()

Inherited Method Summary

From class com.google.firebase.storage.ControllableTask

abstract ControllableTask<ResultT extends StorageTask.ProvideError>	addOnPausedListener(Activity activity, OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<ResultT extends StorageTask.ProvideError>	addOnPausedListener(OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract ControllableTask<ResultT extends StorageTask.ProvideError>	addOnPausedListener(Executor executor, OnPausedListener<? super StateT> listener) Adds a listener that is called when the Task becomes paused.
abstract boolean	isPaused()
abstract boolean	pause() Attempts to pause the task.
abstract boolean	resume() Attempts to resume this task.

From class com.google.firebase.storage.CancellableTask

abstract CancellableTask<ResultT extends StorageTask.ProvideError>	addOnProgressListener(OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<ResultT extends StorageTask.ProvideError>	addOnProgressListener(Activity activity, OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract CancellableTask<ResultT extends StorageTask.ProvideError>	addOnProgressListener(Executor executor, OnProgressListener<? super StateT> listener) Adds a listener that is called periodically while the ControllableTask executes.
abstract boolean	cancel() Attempts to cancel the task.
abstract boolean	isCanceled()
abstract boolean	isInProgress()

From class com.google.android.gms.tasks.Task

Task<ResultT extends StorageTask.ProvideError>	addOnCanceledListener(OnCanceledListener arg0)
Task<ResultT extends StorageTask.ProvideError>	addOnCanceledListener(Executor arg0, OnCanceledListener arg1)
Task<ResultT extends StorageTask.ProvideError>	addOnCanceledListener(Activity arg0, OnCanceledListener arg1)
Task<ResultT extends StorageTask.ProvideError>	addOnCompleteListener(OnCompleteListener<ResultT extends StorageTask.ProvideError> arg0)
Task<ResultT extends StorageTask.ProvideError>	addOnCompleteListener(Activity arg0, OnCompleteListener<ResultT extends StorageTask.ProvideError> arg1)
Task<ResultT extends StorageTask.ProvideError>	addOnCompleteListener(Executor arg0, OnCompleteListener<ResultT extends StorageTask.ProvideError> arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnFailureListener(Activity arg0, OnFailureListener arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnFailureListener(OnFailureListener arg0)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnFailureListener(Executor arg0, OnFailureListener arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnSuccessListener(Executor arg0, OnSuccessListener<? super TResult> arg1)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnSuccessListener(OnSuccessListener<? super TResult> arg0)
abstract Task<ResultT extends StorageTask.ProvideError>	addOnSuccessListener(Activity arg0, OnSuccessListener<? super TResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWith(Continuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWith(Executor arg0, Continuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Continuation<ResultT extends StorageTask.ProvideError, Task<TContinuationResult>> arg0)
<TContinuationResult> Task<TContinuationResult>	continueWithTask(Executor arg0, Continuation<ResultT extends StorageTask.ProvideError, Task<TContinuationResult>> arg1)
abstract Exception	getException()
abstract ResultT extends StorageTask.ProvideError	getResult()
abstract <X extends Throwable> ResultT extends StorageTask.ProvideError	getResult(Class<X> arg0)
abstract boolean	isCanceled()
abstract boolean	isComplete()
abstract boolean	isSuccessful()
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(Executor arg0, SuccessContinuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg1)
<TContinuationResult> Task<TContinuationResult>	onSuccessTask(SuccessContinuation<ResultT extends StorageTask.ProvideError, TContinuationResult> arg0)

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 Object syncObject

Protected Constructors

protected StorageTask ()

Also: Google Play services

Public Methods

public StorageTask<ResultT> addOnCanceledListener (OnCanceledListener listener)

Also: Google Play services

Adds a listener that is called if the Task is canceled.

The listener will be called on main application thread. If the Task has already been canceled, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Returns

this Task

public StorageTask<ResultT> addOnCanceledListener (Executor executor, OnCanceledListener listener)

Also: Google Play services

Adds a listener that is called if the Task is canceled.

If the Task has already been canceled, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Parameters

executor	the executor to use to call the listener
listener

Returns

this Task

public StorageTask<ResultT> addOnCanceledListener (Activity activity, OnCanceledListener listener)

Also: Google Play services

Adds an Activity-scoped listener that is called if the Task is canceled.

The listener will be automatically removed during onStop().

Returns

this Task

public StorageTask<ResultT> addOnCompleteListener (Activity activity, OnCompleteListener<ResultT> listener)

Adds a listener that is called when the Task succeeds or fails.

If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Parameters

activity	When the supplied `Activity` stops, this listener will automatically be removed.
listener

Returns

this Task

public StorageTask<ResultT> addOnCompleteListener (OnCompleteListener<ResultT> listener)

Adds a listener that is called when the Task succeeds or fails.

The listener will be called on main application thread. If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Returns

this Task

public StorageTask<ResultT> addOnCompleteListener (Executor executor, OnCompleteListener<ResultT> listener)

Adds a listener that is called when the Task succeeds or fails.

If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Parameters

executor	the executor to use to call the listener
listener

Returns

this Task

public StorageTask<ResultT> addOnFailureListener (Activity activity, OnFailureListener listener)

Also: Google Play services

Adds a listener that is called if the Task fails.

If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Parameters

activity	When the supplied `Activity` stops, this listener will automatically be removed.
listener

Returns

this Task

public StorageTask<ResultT> addOnFailureListener (OnFailureListener listener)

Also: Google Play services

Adds a listener that is called if the Task fails.

Returns

this Task

public StorageTask<ResultT> addOnFailureListener (Executor executor, OnFailureListener listener)

Also: Google Play services

Adds a listener that is called if the Task fails.

If the task has already failed, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Parameters

executor	the executor to use to call the listener
listener

Returns

this Task

public StorageTask<ResultT> addOnPausedListener (Executor executor, OnPausedListener<? super ResultT> listener)

Adds a listener that is called when the Task becomes paused.

Parameters

executor	the executor to use to call the listener
listener

Returns

this Task

public StorageTask<ResultT> addOnPausedListener (OnPausedListener<? super ResultT> listener)

Adds a listener that is called when the Task becomes paused.

Returns

this Task

public StorageTask<ResultT> addOnPausedListener (Activity activity, OnPausedListener<? super ResultT> listener)

Adds a listener that is called when the Task becomes paused.

Parameters

activity	When the supplied `Activity` stops, this listener will automatically be removed.
listener

Returns

this Task

public StorageTask<ResultT> addOnProgressListener (OnProgressListener<? super ResultT> listener)

Adds a listener that is called periodically while the ControllableTask executes.

Returns

this Task

public StorageTask<ResultT> addOnProgressListener (Activity activity, OnProgressListener<? super ResultT> listener)

Adds a listener that is called periodically while the ControllableTask executes.

Parameters

activity	When the supplied `Activity` stops, this listener will automatically be removed.
listener

Returns

this Task

public StorageTask<ResultT> addOnProgressListener (Executor executor, OnProgressListener<? super ResultT> listener)

Adds a listener that is called periodically while the ControllableTask executes.

Parameters

executor	the executor to use to call the listener
listener

Returns

this Task

public StorageTask<ResultT> addOnSuccessListener (OnSuccessListener<? super ResultT> listener)

Adds a listener that is called if the Task completes successfully. The listener will be called on the main application thread. If the task has already completed successfully, a call to the listener will be immediately scheduled. If multiple listeners are added, they will be called in the order in which they were added.

Returns

this Task

public StorageTask<ResultT> addOnSuccessListener (Executor executor, OnSuccessListener<? super ResultT> listener)

Adds a listener that is called if the Task completes successfully.

If multiple listeners are added, they will be called in the order in which they were added. If the task has already completed successfully, a call to the listener will be immediately scheduled.

Parameters

executor	the executor to use to call the listener
listener

Returns

this Task

public StorageTask<ResultT> addOnSuccessListener (Activity activity, OnSuccessListener<? super ResultT> listener)

Adds a listener that is called if the Task completes successfully.

If multiple listeners are added, they will be called in the order in which they were added. If the task has already completed successfully, a call to the listener will be immediately scheduled.

Parameters

activity	When the supplied `Activity` stops, this listener will automatically be removed.
listener

Returns

this Task

public boolean cancel ()

Also: Google Play services

Attempts to cancel the task. A canceled task cannot be resumed later.

Returns

true if this task is successfully being canceled.

public Task<ContinuationResultT> continueWith (Continuation<ResultT, ContinuationResultT> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

The Continuation will be called on the main application thread.

public Task<ContinuationResultT> continueWith (Executor executor, Continuation<ResultT, ContinuationResultT> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

Parameters

executor	the executor to use to call the Continuation
continuation

public Task<ContinuationResultT> continueWithTask (Executor executor, Continuation<ResultT, Task<ContinuationResultT>> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

Parameters

executor	the executor to use to call the Continuation
continuation

public Task<ContinuationResultT> continueWithTask (Continuation<ResultT, Task<ContinuationResultT>> continuation)

Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.

The Continuation will be called on the main application thread.

public Exception getException ()

Also: Google Play services

Returns the exception that caused the Task to fail. Returns null if the Task is not yet complete, or completed successfully.

public ResultT getResult ()

Also: Google Play services

Gets the result of the Task, if it has already completed.

Throws

IllegalStateException	if the Task is not yet complete
RuntimeExecutionException	if the Task failed with an exception

public ResultT getResult (Class<X> exceptionType)

Also: Google Play services

Gets the result of the Task, if it has already completed.

Throws

IllegalStateException	if the Task is not yet complete
	if the Task failed with an exception of type X
RuntimeExecutionException	if the Task failed with an exception that was not of type X
Throwable

public ResultT getSnapshot ()

Also: Google Play services

Returns the current state of the task. This method will return state at any point of the tasks execution and may not be the final result..

public boolean isCanceled ()

Also: Google Play services

Returns true if the task has been canceled.

Returns

true if the task has been canceled.

public boolean isComplete ()

Also: Google Play services

Returns true if the Task is complete; false otherwise.

public boolean isInProgress ()

Also: Google Play services

Returns true if the task is currently running.

Returns

true if the task is currently running.

public boolean isPaused ()

Also: Google Play services

Returns true if the task has been paused.

Returns

true if the task has been paused.

public boolean isSuccessful ()

Also: Google Play services

Returns true if the Task has completed successfully; false otherwise.

public Task<ContinuationResultT> onSuccessTask (SuccessContinuation<ResultT, ContinuationResultT> continuation)

Returns a new Task that will be completed with the result of applying the specified SuccessContinuation to this Task when this Task completes successfully. If the previous Task fails, the onSuccessTask completion will be skipped and failure listeners will be invoked.

The SuccessContinuation will be called on the main application thread.

If the previous Task is canceled, the returned Task will also be canceled and the SuccessContinuation would not execute.

public Task<ContinuationResultT> onSuccessTask (Executor executor, SuccessContinuation<ResultT, ContinuationResultT> continuation)

If the previous Task is canceled, the returned Task will also be canceled and the SuccessContinuation would not execute.

Parameters

executor	the executor to use to call the SuccessContinuation
continuation

public boolean pause ()

Also: Google Play services

Attempts to pause the task. A paused task can later be resumed.

Returns

true if this task is successfully being paused. Note that a task may not be immediately paused if it was executing another action and can still fail or complete.

public StorageTask<ResultT> removeOnCanceledListener (OnCanceledListener listener)

Removes a listener.

public StorageTask<ResultT> removeOnCompleteListener (OnCompleteListener<ResultT> listener)

Removes a listener.

public StorageTask<ResultT> removeOnFailureListener (OnFailureListener listener)

Also: Google Play services

Removes a listener.

public StorageTask<ResultT> removeOnPausedListener (OnPausedListener<? super ResultT> listener)

Removes a listener.

public StorageTask<ResultT> removeOnProgressListener (OnProgressListener<? super ResultT> listener)

Removes a listener.

public StorageTask<ResultT> removeOnSuccessListener (OnSuccessListener<? super ResultT> listener)

Removes a listener.

public boolean resume ()

Also: Google Play services

Attempts to resume a paused task.

Returns

true if the task is successfully resumed. false if the task has an unrecoverable error or has entered another state that precludes resume.

Protected Methods

StorageTask

Nested Class Summary

Field Summary

Protected Constructor Summary

Public Method Summary

Protected Method Summary

Inherited Method Summary

Fields

protected final Object syncObject

Protected Constructors

protected StorageTask ()

Public Methods

public StorageTask<ResultT> addOnCanceledListener (OnCanceledListener listener)

Returns

public StorageTask<ResultT> addOnCanceledListener (Executor executor, OnCanceledListener listener)

Parameters

Returns

public StorageTask<ResultT> addOnCanceledListener (Activity activity, OnCanceledListener listener)

Returns

public StorageTask<ResultT> addOnCompleteListener (Activity activity, OnCompleteListener<ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnCompleteListener (OnCompleteListener<ResultT> listener)

Returns

public StorageTask<ResultT> addOnCompleteListener (Executor executor, OnCompleteListener<ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnFailureListener (Activity activity, OnFailureListener listener)

Parameters

Returns

public StorageTask<ResultT> addOnFailureListener (OnFailureListener listener)

Returns

public StorageTask<ResultT> addOnFailureListener (Executor executor, OnFailureListener listener)

Parameters

Returns

public StorageTask<ResultT> addOnPausedListener (Executor executor, OnPausedListener<? super ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnPausedListener (OnPausedListener<? super ResultT> listener)

Returns

public StorageTask<ResultT> addOnPausedListener (Activity activity, OnPausedListener<? super ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnProgressListener (OnProgressListener<? super ResultT> listener)

Returns

public StorageTask<ResultT> addOnProgressListener (Activity activity, OnProgressListener<? super ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnProgressListener (Executor executor, OnProgressListener<? super ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnSuccessListener (OnSuccessListener<? super ResultT> listener)

Returns

public StorageTask<ResultT> addOnSuccessListener (Executor executor, OnSuccessListener<? super ResultT> listener)

Parameters

Returns

public StorageTask<ResultT> addOnSuccessListener (Activity activity, OnSuccessListener<? super ResultT> listener)

Parameters

Returns

public boolean cancel ()

Returns

public Task<ContinuationResultT> continueWith (Continuation<ResultT, ContinuationResultT> continuation)

See Also

public Task<ContinuationResultT> continueWith (Executor executor, Continuation<ResultT, ContinuationResultT> continuation)

Parameters

See Also

public Task<ContinuationResultT> continueWithTask (Executor executor, Continuation<ResultT, Task<ContinuationResultT>> continuation)

Parameters

See Also

public Task<ContinuationResultT> continueWithTask (Continuation<ResultT, Task<ContinuationResultT>> continuation)

See Also

public Exception getException ()

public ResultT getResult ()

Throws

public ResultT getResult (Class<X> exceptionType)

Throws

public ResultT getSnapshot ()

public boolean isCanceled ()

Returns

public boolean isComplete ()