Package org.apache.calcite.util

Class CancelFlag

  • public class CancelFlag
extends java.lang.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
      java.util.concurrent.atomic.AtomicBoolean atomicBoolean
      The flag that holds the cancel state.

    • Constructor Summary

      Constructors 
      Constructor Description
      CancelFlag​(java.util.concurrent.atomic.AtomicBoolean atomicBoolean)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearCancel()
      Clears any pending cancellation request.
      boolean isCancelRequested()  
      void requestCancel()
      Requests a cancellation.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • atomicBoolean

        public final java.util.concurrent.atomic.AtomicBoolean atomicBoolean
        The flag that holds the cancel state. Feel free to use the flag directly.

    • Constructor Detail

      • CancelFlag

        public CancelFlag​(java.util.concurrent.atomic.AtomicBoolean atomicBoolean)

    • Method Detail

      • 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.