CancellationSignal

Provides the ability to cancel an operation in progress.

Summary

Nested Classes
interface	CancellationSignal.OnCancelListener	Listens for cancellation.

Nested Classes

interface

CancellationSignal.OnCancelListener

Listens for cancellation.

Public Constructors
	CancellationSignal() Creates a cancellation signal, initially not canceled.

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.

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Methods

public void cancel ()

Added in API level 16

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.

public boolean isCanceled ()

Added in API level 16

Returns true if the operation has been canceled.

Returns

True if the operation has been canceled.

public void setOnCancelListener (CancellationSignal.OnCancelListener listener)

Added in API level 16

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	The cancellation listener, or null to remove the current listener.

public void throwIfCanceled ()

Added in API level 16

Throws OperationCanceledException if the operation has been canceled.

Throws

OperationCanceledException	if the operation has been canceled.

Results

Interfaces

Classes

Enums

Exceptions

Class Overview

Summary

Public Constructors

public CancellationSignal ()

Public Methods

public void cancel ()

public boolean isCanceled ()

Returns

public void setOnCancelListener (CancellationSignal.OnCancelListener listener)

Parameters

public void throwIfCanceled ()

Throws

java.lang.Object
↳	android.os.CancellationSignal