Task
extends Object| java.lang.Object | |
| ↳ | com.google.firebase.tasks.Task<T> |
Class Overview
Represents an asynchronous operation.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Task() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Task<T> |
addOnCompleteListener(OnCompleteListener<T> listener)
Adds a listener that is called when the Task completes.
| ||||||||||
| Task<T> |
addOnCompleteListener(Executor executor, OnCompleteListener<T> listener)
Adds a listener that is called when the Task completes.
| ||||||||||
| abstract Task<T> |
addOnFailureListener(Executor executor, OnFailureListener listener)
Adds a listener that is called if the Task fails.
| ||||||||||
| abstract Task<T> |
addOnFailureListener(OnFailureListener listener)
Adds a listener that is called if the Task fails.
| ||||||||||
| abstract Task<T> |
addOnSuccessListener(OnSuccessListener<? super T> listener)
Adds a listener that is called if the Task completes successfully.
| ||||||||||
| abstract Task<T> |
addOnSuccessListener(Executor executor, OnSuccessListener<? super T> listener)
Adds a listener that is called if the Task completes successfully.
| ||||||||||
| <R> Task<R> |
continueWith(Executor executor, Continuation<T, R> continuation)
Returns a new Task that will be completed with the result of applying the specified
Continuation to this Task.
| ||||||||||
| <R> Task<R> |
continueWith(Continuation<T, R> continuation)
Returns a new Task that will be completed with the result of applying the specified
Continuation to this Task.
| ||||||||||
| <R> Task<R> |
continueWithTask(Continuation<T, Task<R>> continuation)
Returns a new Task that will be completed with the result of applying the specified
Continuation to this Task.
| ||||||||||
| <R> Task<R> |
continueWithTask(Executor executor, Continuation<T, Task<R>> continuation)
Returns a new Task that will be completed with the result of applying the specified
Continuation to this Task.
| ||||||||||
| abstract Exception |
getException()
Returns the exception that caused the Task to fail.
| ||||||||||
| abstract T |
getResult()
Gets the result of the Task, if it has already completed.
| ||||||||||
| abstract <X extends Throwable> T |
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. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public Task ()
Public Methods
public Task<T> addOnCompleteListener (OnCompleteListener<T> listener)
Adds a listener that is called when the Task completes.
The listener will be called on a shared thread pool. 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.
Returns
- this Task
public Task<T> addOnCompleteListener (Executor executor, OnCompleteListener<T> 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 | the executor to use to call the listener |
|---|
Returns
- this Task
public abstract Task<T> 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 | the executor to use to call the listener |
|---|
Returns
- this Task
public abstract Task<T> addOnFailureListener (OnFailureListener listener)
Adds a listener that is called if the Task fails.
The listener will be called on a shared thread pool. 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 abstract Task<T> addOnSuccessListener (OnSuccessListener<? super T> listener)
Adds a listener that is called if the Task completes successfully.
The listener will be called on a shared thread pool. 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 abstract Task<T> addOnSuccessListener (Executor executor, OnSuccessListener<? super T> 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 |
|---|
Returns
- this Task
public Task<R> continueWith (Executor executor, Continuation<T, R> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
If the Continuation throws an exception, the returned Task will fail with that exception.
Parameters
| executor | the executor to use to call the Continuation |
|---|
See Also
public Task<R> continueWith (Continuation<T, R> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
If the Continuation throws an exception, the returned Task will fail with that exception.
The Continuation will be called on a shared thread pool.
public Task<R> continueWithTask (Continuation<T, Task<R>> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
If the Continuation throws an exception, the returned Task will fail with that exception.
The Continuation will be called on a shared thread pool.
public Task<R> continueWithTask (Executor executor, Continuation<T, Task<R>> continuation)
Returns a new Task that will be completed with the result of applying the specified Continuation to this Task.
If the Continuation throws an exception, the returned Task will fail with that exception.
Parameters
| executor | the executor to use to call the Continuation |
|---|
See Also
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.
public abstract T getResult ()
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 abstract T getResult (Class<X> exceptionType)
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 abstract boolean isComplete ()
Returns true if the Task is complete; false otherwise.
public abstract boolean isSuccessful ()
Returns true if the Task has completed successfully; false otherwise.