public
final
class
CancellationSignal
extends Object
| java.lang.Object | |
| ↳ | android.support.v4.os.CancellationSignal |
Static library support version of the framework's CancellationSignal.
Used to write apps that run on platforms prior to Android 4.1. See the framework SDK
documentation for a class overview.
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. |
Object
|
getCancellationSignalObject()
Gets the framework |
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 |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
CancellationSignal ()
Creates a cancellation signal, initially not canceled.
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.
Object getCancellationSignalObject ()
Gets the framework CancellationSignal associated with this object.
Framework support for cancellation signals was added in
JELLY_BEAN so this method will always
return null on older versions of the platform.
| Returns | |
|---|---|
Object |
A framework cancellation signal object, or null on platform versions prior to Jellybean. |
boolean isCanceled ()
Returns true if the operation has been canceled.
| Returns | |
|---|---|
boolean |
True if the operation has been canceled. |
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.
|
void throwIfCanceled ()
Throws OperationCanceledException if the operation has been canceled.
| Throws | |
|---|---|
OperationCanceledException |
if the operation has been canceled. |
Developers