Summary: Ctors | Methods | Inherited Methods

Task

public abstract class Task
extends Object

java.lang.Object
↳	com.google.android.play.core.tasks.Task<ResultT>

---

Represents an asynchronous operation.

Summary

Public constructors
Task()

Public methods
abstract Task<ResultT>	addOnCompleteListener(OnCompleteListener<ResultT> listener) Adds a listener that is called when the Task completes.
abstract Task<ResultT>	addOnCompleteListener(Executor executor, OnCompleteListener<ResultT> listener) Adds a listener that is called when the Task completes.
abstract Task<ResultT>	addOnFailureListener(Executor executor, OnFailureListener listener) Adds a listener that is called if the Task fails.
abstract Task<ResultT>	addOnFailureListener(OnFailureListener listener) Adds a listener that is called if the Task fails.
abstract Task<ResultT>	addOnSuccessListener(Executor executor, OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
abstract Task<ResultT>	addOnSuccessListener(OnSuccessListener<? super ResultT> listener) Adds a listener that is called if the Task completes successfully.
abstract Exception	getException() Returns the exception that caused the Task to fail.
abstract ResultT	getResult() Gets the result of the Task, if it has already completed.
abstract <X extends Throwable> ResultT	getResult(Class<X> exceptionType) Gets the result of the Task, if it has already completed.
abstract boolean	isComplete() Returns true if the Task is complete; false otherwise.
abstract boolean	isSuccessful() Returns true if the Task has completed successfully; false otherwise.

Inherited methods
From class java.lang.Object boolean equals(Object arg0) 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()

Public constructors

Task

public Task ()

Public methods

addOnCompleteListener

public abstract Task<ResultT> addOnCompleteListener (OnCompleteListener<ResultT> listener)

Adds a listener that is called when the Task completes.

The listener will be called on main application thread. If the Task is already complete, 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
listener	OnCompleteListener

Returns
Task<ResultT>	this Task

addOnCompleteListener

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

Adds a listener that is called when the Task completes.

If the Task is already complete, 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	Executor: the executor to use to call the listener
listener	OnCompleteListener

Returns
Task<ResultT>	this Task

addOnFailureListener

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

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	Executor: the executor to use to call the listener
listener	OnFailureListener

Returns
Task<ResultT>	this Task

addOnFailureListener

public abstract Task<ResultT> addOnFailureListener (OnFailureListener listener)

Adds a listener that is called if the Task 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.

Parameters
listener	OnFailureListener

Returns
Task<ResultT>	this Task

addOnSuccessListener

public abstract Task<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	Executor: the executor to use to call the listener
listener	OnSuccessListener

Returns
Task<ResultT>	this Task

addOnSuccessListener

public abstract Task<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.

Parameters
listener	OnSuccessListener

Returns
Task<ResultT>	this Task

getException

public abstract Exception getException ()

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

Returns
Exception

getResult

public abstract ResultT getResult ()

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

Returns
ResultT

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

getResult

public abstract ResultT getResult (Class<X> exceptionType)

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

Parameters
exceptionType	Class

Returns
ResultT

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

isComplete

public abstract boolean isComplete ()

Returns true if the Task is complete; false otherwise.

Returns
boolean

isSuccessful

public abstract boolean isSuccessful ()

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

Returns
boolean