InterruptionToken

Inheritance: java.lang.Object

public class InterruptionToken implements IInterruptionToken

This class represents the token to use for signaling long running tasks whether the interruption was requested.

Methods

Method	Description
getNone()	Represents an empty interruption token.
isInterruptionRequested()	Returns true if interruption was requested.
throwIfInterruptionRequested()	Throws an if interruption was requested.

public static InterruptionToken getNone()

Represents an empty interruption token.

Long-running operations will never be interrupted via InterruptionTokenSource.interrupt when using this token.

Returns: InterruptionToken

public final boolean isInterruptionRequested()

Returns true if interruption was requested.

Returns: boolean

public final void throwIfInterruptionRequested()

Throws an if interruption was requested.