Module async.generator

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:

AutoCloseable, 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>

Nested Class Summary

Nested classes/interfaces inherited from interface org.bsc.async.AsyncGenerator

AsyncGenerator.Base<E>, AsyncGenerator.BaseCancellable<E>, AsyncGenerator.Cancellable<E>, AsyncGenerator.Data<E>, AsyncGenerator.Embed<E>, AsyncGenerator.EmbedCompletionHandler, AsyncGenerator.HasResultValue, AsyncGenerator.IsCancellable, AsyncGenerator.WithEmbed<E>, AsyncGenerator.WithResult<E>

Field Summary

Fields inherited from interface org.bsc.async.AsyncGenerator.IsCancellable

CANCELLED

Constructor Summary

Constructors

Constructor	Description
BaseCancellable()

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)	Requests cancellation of the generator.
boolean	isCancelled()	Checks if the asynchronous generation has been cancelled.

Methods inherited from class org.bsc.async.AsyncGenerator.Base

close, executor, isClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bsc.async.AsyncGenerator

executor, flatMap, forEachAsync, iterator, map, next, reduce, reduceAsync, stream, toCompletableFuture, toCompletableFutureAsync

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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)

Requests cancellation of the generator.

This method sets the cancelled flag and closes the executor to release resources. If mayInterruptIfRunning is true, the executor will be shut down immediately, interrupting any running tasks.

Specified by:

cancel in interface AsyncGenerator.IsCancellable

Parameters:

mayInterruptIfRunning - if true, interrupt running tasks

Returns:

true if cancellation was successful, false if already cancelled