CancellableThreads.OnCancel (server 7.6.2 API)

Enclosing class:: CancellableThreads

Functional Interface:: This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface CancellableThreads.OnCancel

Method Summary

Modifier and Type	Method	Description
`void`	`onCancel(java.lang.String reason, java.lang.Exception beforeCancelException)`	Called when some running operations are cancelled or `CancellableThreads.checkForCancel()` is explicitly called.

Method Details
- onCancel
  
  void onCancel(java.lang.String reason, @Nullable java.lang.Exception beforeCancelException)
  
  Called when some running operations are cancelled or CancellableThreads.checkForCancel() is explicitly called. If this method throws an exception, cancelling tasks will fail with that exception; otherwise they will fail with the default exception CancellableThreads.ExecutionCancelledException.
  
  Parameters:
  
  reason - the reason of the cancellation
  
  beforeCancelException - any error that was encountered during the execution before the operations were cancelled.
  
  See Also:
  
  CancellableThreads.checkForCancel(), CancellableThreads.setOnCancel(OnCancel)