CancellationToken

Class CancellationToken

java.lang.Object

com.grapecity.documents.excel.CancellationToken

---

public class CancellationToken extends Object

传播应取消操作通知的令牌。

此类是线程安全的。通常，通过 CancellationTokenSource.getToken() 从 CancellationTokenSource 获取 CancellationToken，并将其传递给 Workbook.processTemplate(CancellationToken) 等长时间运行的操作。然后该操作可以检查 isCancellationRequested() 以确定是否已请求取消。

 try (CancellationTokenSource cts = new CancellationTokenSource()) {
     CancellationToken token = cts.getToken();
     cts.cancelAfter(Duration.ofSeconds(10));
     workbook.processTemplate(token);
 } catch (Exception e) {
 }
 

• Constructor Summary

  Constructors

  Constructor

  Description

  CancellationToken()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  boolean

  isCancellationRequested()

  获取是否已请求取消此令牌。

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • CancellationToken

    public CancellationToken()

• Method Details

  • isCancellationRequested

    public boolean isCancellationRequested()

    获取是否已请求取消此令牌。

    
     try (CancellationTokenSource cts = new CancellationTokenSource()) {
         CancellationToken token = cts.getToken();
         cts.cancel();
         boolean cancellationRequested = token.isCancellationRequested();
     }
     

    Returns:

    取消状态。