次の方法で共有

CancellationToken クラス

  • リファレンス
パッケージ:
system.fabric
  • java.lang.Object
    • AutoCloseable
      • system.fabric.CancellationToken

public class CancellationToken

CancellationToken は、操作を取り消す必要があることを示す通知を伝達するために使用されます。 キャンセル トークンを作成するには、 オブジェクトを CancellationTokenSource インスタンス化し、そのメソッドから取得したキャンセル トークンを getToken() 管理します。 次に、取り消しトークンを、取り消し通知を受け取る必要がある任意の数の操作に渡します。 トークンを使用して取り消しを開始することはできません。 所有オブジェクトが を呼び出 cancel()すと、取り消しトークンの canceled プロパティが true に設定されます。 通知を受け取るオブジェクトは、適切な方法で応答できます。

メソッドの概要

修飾子と型 メソッドと説明
boolean canBeCancelled()

キャンセル トークンを取り消すことができるかどうかを指定します。 が system.fabric.CancellationToken を使用して getToken()作成された場合、トークンは メソッドを使用して cancel() 取り消すことができます。 を system.fabric.CancellationToken 使用して getDefault()を作成した場合は、取り消しできません。 これは単にダミー トークンとして機能します。

void close()
CancellationToken getDefault()

Cancellation トークン オブジェクトを作成して返します。 CancellationToken で取り消しがサポートされていない場合は、このメソッドを使用する必要があります。 によって作成された getToken() キャンセル トークンのみがキャンセルをサポートします。
boolean isCancelled()

このトークンに対して取り消しが要求されたかどうかを取得します。
void registerCancellationCallback(Runnable callback)

この system.fabric.CancellationToken オブジェクトが取り消されたときに実行されるコールバックを登録します。

void registerCancellationCallback(String name, Runnable callback)

この system.fabric.CancellationToken オブジェクトが取り消されたときに実行されるコールバックを登録します。

void throwIfCancellationRequested()

このトークンに取り消しが要求されている場合は、CancellationException をスローします。

void unregisterCancellationCallback()

この system.fabric.CancellationToken オブジェクトのコールバックの登録を解除します。

void unregisterCancellationCallback(String name)

この system.fabric.CancellationToken オブジェクトのコールバックの登録を解除します。

メソッドの詳細

canBeCancelled

public boolean canBeCancelled()

キャンセル トークンを取り消すことができるかどうかを指定します。 が system.fabric.CancellationToken を使用して getToken()作成された場合、トークンは メソッドを使用して cancel() 取り消すことができます。 を system.fabric.CancellationToken 使用して getDefault()を作成した場合は、取り消しできません。 これは単にダミー トークンとして機能します。

戻り値:

トークンを取り消すことができる場合は true、それ以外の場合は false を返します。

close

public void close()

getDefault

public static CancellationToken getDefault()

Cancellation トークン オブジェクトを作成して返します。 CancellationToken で取り消しがサポートされていない場合は、このメソッドを使用する必要があります。 によって作成された getToken() キャンセル トークンのみがキャンセルをサポートします。

戻り値:

isCancelled

public boolean isCancelled()

このトークンに対して取り消しが要求されたかどうかを取得します。

戻り値:

ブールの取り消し状態

registerCancellationCallback

public void registerCancellationCallback(Runnable callback)

この system.fabric.CancellationToken オブジェクトが取り消されたときに実行されるコールバックを登録します。

パラメーター:

callback -

java.lang.Runnable トークンキャンセルイベント時に実行されます。

registerCancellationCallback

public void registerCancellationCallback(String name, Runnable callback)

この system.fabric.CancellationToken オブジェクトが取り消されたときに実行されるコールバックを登録します。

パラメーター:

name - コールバック名。
callback -

java.lang.Runnable トークンキャンセルイベント時に実行されます。

throwIfCancellationRequested

public void throwIfCancellationRequested()

このトークンに取り消しが要求されている場合は、CancellationException をスローします。

unregisterCancellationCallback

public void unregisterCancellationCallback()

この system.fabric.CancellationToken オブジェクトのコールバックの登録を解除します。

unregisterCancellationCallback

public void unregisterCancellationCallback(String name)

この system.fabric.CancellationToken オブジェクトのコールバックの登録を解除します。

パラメーター:

name - この system.fabric.CancellationToken オブジェクトに登録されているコールバック名。

適用対象