Compartilhar via

CancellationToken Classe

  • Referência
Pacote:
system.fabric
  • java.lang.Object
    • AutoCloseable
      • system.fabric.CancellationToken

public class CancellationToken

Um CancellationToken é usado para propagar a notificação de que as operações devem ser canceladas. Você cria um token de cancelamento criando uma instância de um CancellationTokenSource objeto , que gerencia tokens de cancelamento recuperados de seu getToken() método. Em seguida, você passa o token de cancelamento para qualquer número de operações que devem receber aviso de cancelamento. O token não pode ser usado para iniciar o cancelamento. Quando o objeto proprietário chama cancel(), a propriedade cancelada no token de cancelamento é definida como true. Os objetos que recebem a notificação podem responder de qualquer maneira apropriada.

Resumo do método

Modificador e tipo Método e descrição
boolean canBeCancelled()

Especifica se o token de cancelamento pode ser cancelado ou não. Se o system.fabric.CancellationToken for criado usando getToken(), o token poderá ser cancelado usando cancel() o método . Se o system.fabric.CancellationToken for criado usando getDefault(), ele não poderá ser cancelado. Ele simplesmente atua como um token fictício.

void close()
CancellationToken getDefault()

Cria e retorna um objeto de token Cancellation. Esse método deve ser usado quando CancellationToken não dá suporte ao cancelamento. Somente tokens de cancelamento criados por meio getToken() de dão suporte a cancelamentos.
boolean isCancelled()

Especifica se o cancelamento foi solicitado para esse token.
void registerCancellationCallback(Runnable callback)

Registra um retorno de chamada que será executado quando esse system.fabric.CancellationToken objeto for cancelado.

void registerCancellationCallback(String name, Runnable callback)

Registra um retorno de chamada que será executado quando esse system.fabric.CancellationToken objeto for cancelado.

void throwIfCancellationRequested()

Gerará uma CancellationException se esse token tiver solicitado o cancelamento.

void unregisterCancellationCallback()

cancela o registro do retorno de chamada para esse system.fabric.CancellationToken objeto.

void unregisterCancellationCallback(String name)

cancela o registro do retorno de chamada para esse system.fabric.CancellationToken objeto.

Detalhes do método

canBeCancelled

public boolean canBeCancelled()

Especifica se o token de cancelamento pode ser cancelado ou não. Se o system.fabric.CancellationToken for criado usando getToken(), o token poderá ser cancelado usando cancel() o método . Se o system.fabric.CancellationToken for criado usando getDefault(), ele não poderá ser cancelado. Ele simplesmente atua como um token fictício.

Retornos:

Retornará true se o token puder ser cancelado, caso contrário, false.

close

public void close()

getDefault

public static CancellationToken getDefault()

Cria e retorna um objeto de token Cancellation. Esse método deve ser usado quando CancellationToken não dá suporte ao cancelamento. Somente tokens de cancelamento criados por meio getToken() de dão suporte a cancelamentos.

Retornos:

isCancelled

public boolean isCancelled()

Especifica se o cancelamento foi solicitado para esse token.

Retornos:

status de cancelamento booliano

registerCancellationCallback

public void registerCancellationCallback(Runnable callback)

Registra um retorno de chamada que será executado quando esse system.fabric.CancellationToken objeto for cancelado.

Parâmetros:

callback -

java.lang.Runnable a ser executado quando estiver no evento de cancelamento de token.

registerCancellationCallback

public void registerCancellationCallback(String name, Runnable callback)

Registra um retorno de chamada que será executado quando esse system.fabric.CancellationToken objeto for cancelado.

Parâmetros:

name - nome do retorno de chamada.
callback -

java.lang.Runnable a ser executado quando estiver no evento de cancelamento de token.

throwIfCancellationRequested

public void throwIfCancellationRequested()

Gerará uma CancellationException se esse token tiver solicitado o cancelamento.

unregisterCancellationCallback

public void unregisterCancellationCallback()

cancela o registro do retorno de chamada para esse system.fabric.CancellationToken objeto.

unregisterCancellationCallback

public void unregisterCancellationCallback(String name)

cancela o registro do retorno de chamada para esse system.fabric.CancellationToken objeto.

Parâmetros:

name - nome de retorno de chamada registrado para este system.fabric.CancellationToken objeto.

Aplica-se a