at.ac.tuwien.infosys.jcloudscale.utility

Class CancellationToken

java.lang.Object

at.ac.tuwien.infosys.jcloudscale.utility.CancellationToken

public class CancellationToken
extends Object

Author:

RST Cancellation token class that allows to cancel asynchronous operation from the outside.

Constructor Summary

Constructors

Constructor and Description
CancellationToken() Creates a new instance of CancellationToken
CancellationToken(CancellationToken parentToken) Creates a new instance of CancellationToken with parentToken specified.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the token.
boolean	isCancelled() Determines if the operation has to be cancelled.
static boolean	isCancelled(CancellationToken token) Allows to check if provided token is cancelled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CancellationToken

public CancellationToken()

Creates a new instance of CancellationToken

CancellationToken

public CancellationToken(CancellationToken parentToken)

Creates a new instance of CancellationToken with parentToken specified.

Parameters:

parentToken - The parent token. If the parent token will be cancelled, this token will report as cancelled as well.

Method Detail

cancel

public void cancel()

Cancels the token.

isCancelled

public boolean isCancelled()

Determines if the operation has to be cancelled. Asynchronous operations are expected to check this method periodically.

Returns:

true if operation was cancelled. Otherwise, false.

isCancelled

public static boolean isCancelled(CancellationToken token)

Allows to check if provided token is cancelled. This operation is useful if you don't want to check for a null in addition.

Parameters:

token - The token to check or null.

Returns:

true if token is provided and it is cancelled. Otherwise, false.