CancellableThreads (elasticsearch-extend 3.2 API)

java.lang.Object
- org.elasticsearch.common.util.CancellableThreads

```
public class CancellableThreads
extends Object
```
A utility class for multi threaded operation that needs to be cancellable via interrupts. Every cancellable operation should be executed via execute(Interruptible), which will capture the executing thread and make sure it is interrupted in the case of cancellation. Cancellation policy: This class does not support external interruption via Thread#interrupt(). Always use #cancel() instead.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CancellableThreads.ExecutionCancelledException`
`static interface`	`CancellableThreads.Interruptible`
`static interface`	`CancellableThreads.IOInterruptible`
`static interface`	`CancellableThreads.OnCancel`

Constructor Summary

Constructors
Constructor Description

CancellableThreads()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`cancel(String reason)`	cancel all current running operations.
`void`	`checkForCancel()`
`void`	`execute(CancellableThreads.Interruptible interruptible)`	run the Interruptible, capturing the executing thread.
`void`	`executeIO(CancellableThreads.IOInterruptible interruptible)`	run the Interruptible, capturing the executing thread.
`boolean`	`isCancelled()`
`void`	`setOnCancel(CancellableThreads.OnCancel onCancel)`	Registers a callback that will be invoked when some running operations are cancelled or `checkForCancel()` is called.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CancellableThreads
```
public CancellableThreads()
```
- Method Detail
  - isCancelled
```
public boolean isCancelled()
```
  - checkForCancel
```
public void checkForCancel()
```
  - execute
```
public void execute(CancellableThreads.Interruptible interruptible)
```
    run the Interruptible, capturing the executing thread. Concurrent calls to cancel(String) will interrupt this thread causing the call to prematurely return.
    
    Parameters:
    
    interruptible - code to run
  - executeIO
```
public void executeIO(CancellableThreads.IOInterruptible interruptible)
               throws IOException
```
    run the Interruptible, capturing the executing thread. Concurrent calls to cancel(String) will interrupt this thread causing the call to prematurely return.
    
    Parameters:
    
    interruptible - code to run
    
    Throws:
    
    IOException
  - cancel
```
public void cancel(String reason)
```
    cancel all current running operations. Future calls to checkForCancel() will be failed with the given reason
  - setOnCancel
```
public void setOnCancel(CancellableThreads.OnCancel onCancel)
```
    Registers a callback that will be invoked when some running operations are cancelled or checkForCancel() is called.