CancellationToken Classe

Paquet:

system.fabric

• java.lang.Object
• • AutoCloseable
  • • system.fabric.CancellationToken

public class CancellationToken

Un objet CancelToken est utilisé pour propager une notification indiquant que les opérations doivent être annulées. Vous créez un jeton d’annulation en instanciant un CancellationTokenSource objet, qui gère les jetons d’annulation récupérés à partir de sa getToken() méthode. Vous transmettez ensuite le jeton d’annulation à n’importe quel nombre d’opérations qui doivent recevoir un avis d’annulation. Le jeton ne peut pas être utilisé pour lancer l’annulation. Lorsque l’objet propriétaire appelle cancel(), la propriété annulée sur le jeton d’annulation est définie sur true. Les objets qui reçoivent la notification peuvent répondre de la manière appropriée.

Résumé de la méthode

Modificateur et type	Méthode et description
boolean	canBeCancelled() Spécifie si le jeton d’annulation peut être annulé ou non. Si le system.fabric.CancellationToken est créé à l’aide de getToken(), le jeton peut être annulé à l’aide de la cancel() méthode . Si le est créé à l’aide system.fabric.CancellationToken de getDefault(), il ne peut pas être annulé. Il agit simplement comme un jeton factice.
void	close()
CancellationToken	getDefault() Crée et retourne un objet de jeton d’annulation. Cette méthode doit être utilisée lorsque CancellationToken ne prend pas en charge l’annulation. Seuls les jetons d’annulation créés via getToken() prennent en charge les annulations.
boolean	isCancelled() Détermine si l'annulation a été demandée pour ce jeton.
void	registerCancellationCallback(Runnable callback) Inscrit un rappel qui sera exécuté lorsque cet system.fabric.CancellationToken objet est annulé.
void	registerCancellationCallback(String name, Runnable callback) Inscrit un rappel qui sera exécuté lorsque cet system.fabric.CancellationToken objet est annulé.
void	throwIfCancellationRequested() Lève une exception CancellationException si l’annulation de ce jeton a été demandée.
void	unregisterCancellationCallback() annulez l’inscription du rappel pour cet system.fabric.CancellationToken objet.
void	unregisterCancellationCallback(String name) annulez l’inscription du rappel pour cet system.fabric.CancellationToken objet.

Détails de la méthode

canBeCancelled

public boolean canBeCancelled()

Spécifie si le jeton d’annulation peut être annulé ou non. Si le system.fabric.CancellationToken est créé à l’aide de getToken(), le jeton peut être annulé à l’aide de la cancel() méthode . Si le est créé à l’aide system.fabric.CancellationToken de getDefault(), il ne peut pas être annulé. Il agit simplement comme un jeton factice.

Retours:

Retourne true si le jeton peut être annulé, sinon false.

close

public void close()

getDefault

public static CancellationToken getDefault()

Crée et retourne un objet de jeton d’annulation. Cette méthode doit être utilisée lorsque CancellationToken ne prend pas en charge l’annulation. Seuls les jetons d’annulation créés via getToken() prennent en charge les annulations.

Retours:

CancellationToken

isCancelled

public boolean isCancelled()

Détermine si l'annulation a été demandée pour ce jeton.

Retours:

status d’annulation booléenne

registerCancellationCallback

public void registerCancellationCallback(Runnable callback)

Inscrit un rappel qui sera exécuté lorsque cet system.fabric.CancellationToken objet est annulé.

Paramètres:

callback -

java.lang.Runnable à exécuter lors de l’événement d’annulation de jeton.

registerCancellationCallback

public void registerCancellationCallback(String name, Runnable callback)

Inscrit un rappel qui sera exécuté lorsque cet system.fabric.CancellationToken objet est annulé.

Paramètres:

name - nom du rappel.

callback -

java.lang.Runnable à exécuter lors de l’événement d’annulation de jeton.

throwIfCancellationRequested

public void throwIfCancellationRequested()

Lève une exception CancellationException si l’annulation de ce jeton a été demandée.

unregisterCancellationCallback

public void unregisterCancellationCallback()

annulez l’inscription du rappel pour cet system.fabric.CancellationToken objet.

unregisterCancellationCallback

public void unregisterCancellationCallback(String name)

annulez l’inscription du rappel pour cet system.fabric.CancellationToken objet.

Paramètres:

name - nom de rappel inscrit pour cet system.fabric.CancellationToken objet.