Package org.omegat.core.threads

Class CancellationToken

java.lang.Object

org.omegat.core.threads.CancellationToken

public class CancellationToken
extends Object

Cooperative cancellation token for long-running tasks. Task code should call throwIfCancelled() at safe points.

Constructor Summary

Constructors

Constructor	Description
CancellationToken()

Method Summary

Modifier and Type	Method	Description
boolean	isCancelled()
static CancellationToken	none()
void	throwIfCancelled()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CancellationToken

public CancellationToken()

Method Details

isCancelled

public boolean isCancelled()

throwIfCancelled

public void throwIfCancelled()
                      throws LongProcessInterruptedException

Throws:

LongProcessInterruptedException

none

public static CancellationToken none()

toString

public String toString()

Overrides:

toString in class Object