Package org.apache.calcite.util

Class CancelFlag

java.lang.Object

org.apache.calcite.util.CancelFlag

public class CancelFlag
extends Object

CancelFlag is used to post and check cancellation requests.

Pass it to RelOptPlanner by putting it into a Context.

Field Summary

Fields

Modifier and Type	Field	Description
final AtomicBoolean	atomicBoolean	The flag that holds the cancel state.

Constructor Summary

Constructors

Constructor	Description
CancelFlag(AtomicBoolean atomicBoolean)

Method Summary

Modifier and Type	Method	Description
void	clearCancel()	Clears any pending cancellation request.
boolean	isCancelRequested()	Returns whether a cancellation has been requested.
void	requestCancel()	Requests a cancellation.

Methods inherited from class java.lang.Object

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

Field Details

atomicBoolean

public final AtomicBoolean atomicBoolean

The flag that holds the cancel state. Feel free to use the flag directly.

Constructor Details

CancelFlag

public CancelFlag(AtomicBoolean atomicBoolean)

Method Details

isCancelRequested

public boolean isCancelRequested()

Returns whether a cancellation has been requested.

requestCancel

public void requestCancel()

Requests a cancellation.

clearCancel

public void clearCancel()

Clears any pending cancellation request.