CancellableTask

public abstract class CancellableTask extends Task
Known direct subclasses
ControllableTask

Represents an asynchronous operation that can be paused, resumed and canceled.

Known indirect subclasses
FileDownloadTask

A task that downloads bytes of a GCS blob to a specified File.

StorageTask

A controllable Task that has a synchronized state machine.

StreamDownloadTask

A task that downloads bytes of a GCS blob.

UploadTask

An controllable task that uploads and fires events for success, progress and failure.


Represents an asynchronous operation that can be canceled.

Parameters

the type of state this operation returns in events.

Summary

Public constructors

Public methods

abstract @NonNull CancellableTask

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

abstract @NonNull CancellableTask
addOnProgressListener(
    @NonNull Activity activity,
    @NonNull OnProgressListener<Object> listener
)

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

abstract @NonNull CancellableTask
addOnProgressListener(
    @NonNull Executor executor,
    @NonNull OnProgressListener<Object> listener
)

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

abstract boolean

Attempts to cancel the task.

abstract boolean
abstract boolean

Public constructors

CancellableTask

public CancellableTask()

Public methods

addOnProgressListener

public abstract @NonNull CancellableTask addOnProgressListener(@NonNull OnProgressListener<Object> listener)

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

Returns
@NonNull CancellableTask

this Task

addOnProgressListener

public abstract @NonNull CancellableTask addOnProgressListener(
    @NonNull Activity activity,
    @NonNull OnProgressListener<Object> listener
)

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

Parameters
@NonNull Activity activity

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

Returns
@NonNull CancellableTask

this Task

addOnProgressListener

public abstract @NonNull CancellableTask addOnProgressListener(
    @NonNull Executor executor,
    @NonNull OnProgressListener<Object> listener
)

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

Parameters
@NonNull Executor executor

the executor to use to call the listener

Returns
@NonNull CancellableTask

this Task

cancel

public abstract boolean cancel()

Attempts to cancel the task. A canceled task cannot be resumed later. A canceled task calls back on listeners subscribed to addOnFailureListener with an exception that indicates the task was canceled.

Returns
boolean

true if this task was successfully canceled or is in the process of being canceled. Returns false if the task is already completed or in a state that cannot be canceled.

isCanceled

public abstract boolean isCanceled()
Returns
boolean

true if the task has been canceled.

isInProgress

public abstract boolean isInProgress()
Returns
boolean

true if the task is currently running.