Most visited

Recently visited

Results for

Added in API level 16

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

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

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

CancellationSignal

Added in API level 16

CancellationSignal ()

Creates a cancellation signal, initially not canceled.

Public methods

cancel

Added in API level 16

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

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

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

void throwIfCanceled ()

Throws OperationCanceledException if the operation has been canceled.

Throws
`OperationCanceledException`	if the operation has been canceled.

Interfaces

Classes

Enums

Exceptions

Most visited

Recently visited

Results for

CancellationSignal

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

CancellationSignal

Public methods

cancel

isCanceled

setOnCancelListener

throwIfCanceled