Package org.bsc.async

Class AsyncGenerator.BaseCancellable<E>

java.lang.Object
org.bsc.async.AsyncGenerator.Base<E>
org.bsc.async.AsyncGenerator.BaseCancellable<E>
All Implemented Interfaces:
Iterable<E>, AsyncGenerator<E>, AsyncGenerator.Cancellable<E>, AsyncGenerator.IsCancellable
Direct Known Subclasses:
AsyncGenerator.WithEmbed, AsyncGenerator.WithResult, AsyncGeneratorQueue.Generator
Enclosing interface:
AsyncGenerator<E>

public abstract static class AsyncGenerator.BaseCancellable<E> extends AsyncGenerator.Base<E> implements AsyncGenerator.Cancellable<E>
  • Constructor Details

    • BaseCancellable

      public BaseCancellable()
  • Method Details

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: AsyncGenerator.IsCancellable
      Checks if the asynchronous generation has been cancelled.

      The default implementation always returns false. Implementations that support cancellation should override this method.

      Specified by:
      isCancelled in interface AsyncGenerator.IsCancellable
      Returns:
      true if the generator has been cancelled, false otherwise.
    • cancel

      public boolean cancel(boolean mayInterruptIfRunning)
      Description copied from interface: AsyncGenerator.IsCancellable
      method that request to cancel generator
      Specified by:
      cancel in interface AsyncGenerator.IsCancellable