hr.ngs.templater

Interface DocumentFactory.CancellationToken

Enclosing interface:

DocumentFactory

public static interface DocumentFactory.CancellationToken

Cancel Templater processing.

Templater will often check if isCanceled() returns true in which case it will stop further processing by raising cancellation exception

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentFactory.CancellationToken	NONE Cancellation token which will never cancel processing

Method Summary

Modifier and Type	Method and Description
static DocumentFactory.CancellationToken	forThread(java.lang.Thread thread) Create cancellation token from the status of Thread.isInterrupted()
boolean	isCanceled() Templater will check state of this method in various places and abort further processing when true is returned
default void	throwIfCancellationRequested() Throw cancellation exception if token has been canceled

Field Detail

NONE

static final DocumentFactory.CancellationToken NONE

Cancellation token which will never cancel processing

Method Detail

forThread

static DocumentFactory.CancellationToken forThread(java.lang.Thread thread)

Create cancellation token from the status of Thread.isInterrupted()

Parameters:

thread - thread to check

Returns:

cancellation token used for stopping processing

isCanceled

boolean isCanceled()

Templater will check state of this method in various places and abort further processing when true is returned

Returns:

should processing be canceled

throwIfCancellationRequested

default void throwIfCancellationRequested()

Throw cancellation exception if token has been canceled