Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

CancellationSignal

public final class CancellationSignal
extends Object

java.lang.Object
   ↳ android.os.CancellationSignal


Provides the ability to cancel an operation in progress.

Summary

Nested classes

interface CancellationSignal.OnCancelListener

Listens for cancellation. 

Public constructors

CancellationSignal()

Creates a cancellation signal, initially not canceled.

Public methods

void cancel()

Cancels the operation and signals the cancellation listener.

boolean isCanceled()

Returns true if the operation has been canceled.

void setOnCancelListener(CancellationSignal.OnCancelListener listener)

Sets the cancellation listener to be called when canceled.

void throwIfCanceled()

Throws OperationCanceledException if the operation has been canceled.

Inherited methods

Public constructors

CancellationSignal

added in API level 16
public CancellationSignal ()

Creates a cancellation signal, initially not canceled.

Public methods

cancel

added in API level 16
public void cancel ()

Cancels the operation and signals the cancellation listener. If the operation has not yet started, then it will be canceled as soon as it does.

isCanceled

added in API level 16
public boolean isCanceled ()

Returns true if the operation has been canceled.

Returns
boolean True if the operation has been canceled.

setOnCancelListener

added in API level 16
public void setOnCancelListener (CancellationSignal.OnCancelListener listener)

Sets the cancellation listener to be called when canceled. This method is intended to be used by the recipient of a cancellation signal such as a database or a content provider to handle cancellation requests while performing a long-running operation. This method is not intended to be used by applications themselves. If cancel() has already been called, then the provided listener is invoked immediately. This method is guaranteed that the listener will not be called after it has been removed.

Parameters
listener CancellationSignal.OnCancelListener: The cancellation listener, or null to remove the current listener.

throwIfCanceled

added in API level 16
public void throwIfCanceled ()

Throws OperationCanceledException if the operation has been canceled.

Throws
OperationCanceledException if the operation has been canceled.