Most visited

Recently visited

CancellationSignal

public final class CancellationSignal
extends Object

java.lang.Object
   ↳ android.support.v4.os.CancellationSignal


静态库支持版本的框架CancellationSignal 用于编写在Android 4.1之前的平台上运行的应用程序。 请参阅框架SDK文档以了解类概述。

Summary

Nested classes

interface CancellationSignal.OnCancelListener

听取消。

Public constructors

CancellationSignal()

创建取消信号,最初不会取消。

Public methods

void cancel()

取消操作并发信号通知取消侦听器。

Object getCancellationSignalObject()

获取与此对象关联的框架 CancellationSignal

boolean isCanceled()

如果操作已被取消,则返回true。

void setOnCancelListener(CancellationSignal.OnCancelListener listener)

设置取消时将被调用的取消侦听器。

void throwIfCanceled()

如果操作已取消,则抛出 OperationCanceledException

Inherited methods

From class java.lang.Object

Public constructors

CancellationSignal

CancellationSignal ()

创建取消信号,最初不会取消。

Public methods

cancel

void cancel ()

取消操作并发信号通知取消侦听器。 如果操作还没有开始,那么它会一旦被取消。

getCancellationSignalObject

Object getCancellationSignalObject ()

获取与此对象关联的框架 CancellationSignal

JELLY_BEAN中添加了取消信号的框架支持,因此此方法将在旧版本的平台上始终返回null。

Returns
Object A framework cancellation signal object, or null on platform versions prior to Jellybean.

isCanceled

boolean isCanceled ()

如果操作已被取消,则返回true。

Returns
boolean True if the operation has been canceled.

setOnCancelListener

void setOnCancelListener (CancellationSignal.OnCancelListener listener)

设置取消时将被调用的取消侦听器。 该方法旨在由诸如数据库或内容提供者的取消信号的接收者使用,以在执行长时间运行的操作时处理取消请求。 此方法不适用于应用程序本身。 如果cancel()已被调用,则立即调用所提供的侦听器。 这种方法保证了侦听器在被移除后不会被调用。

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

throwIfCanceled

void throwIfCanceled ()

如果操作已取消,则抛出 OperationCanceledException

Throws
OperationCanceledException if the operation has been canceled.

Hooray!