Module async.generator

Package org.bsc.async

Class AsyncGeneratorQueue.Generator<E>

java.lang.Object

org.bsc.async.AsyncGenerator.Base<E>

org.bsc.async.AsyncGenerator.BaseCancellable<E>

org.bsc.async.AsyncGeneratorQueue.Generator<E>

Type Parameters:

E - the type of elements in the queue

All Implemented Interfaces:

AutoCloseable, Iterable<E>, AsyncGenerator<E>, AsyncGenerator.Cancellable<E>, AsyncGenerator.IsCancellable

Enclosing interface:

AsyncGeneratorQueue

public static class AsyncGeneratorQueue.Generator<E>
extends AsyncGenerator.BaseCancellable<E>

Inner class to generate asynchronous elements from the queue.

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
Generator(BlockingQueue<AsyncGenerator.Data<E>> queue)	Constructs a Generator with the specified queue.

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)	Requests cancellation of the generator.
AsyncGenerator.Data<E>	next()	Retrieves the next element from the queue asynchronously.
BlockingQueue<AsyncGenerator.Data<E>>	queue()

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

isCancelled

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, reduce, reduceAsync, stream, toCompletableFuture, toCompletableFutureAsync

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Generator

public Generator(BlockingQueue<AsyncGenerator.Data<E>> queue)

Constructs a Generator with the specified queue.

Parameters:

queue - the blocking queue to generate elements from

Method Details

queue

public BlockingQueue<AsyncGenerator.Data<E>> queue()

next

public AsyncGenerator.Data<E> next()

Retrieves the next element from the queue asynchronously.

Returns:

the next element from the queue

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Description copied from class: AsyncGenerator.BaseCancellable

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

Overrides:

cancel in class AsyncGenerator.BaseCancellable<E>

Parameters:

mayInterruptIfRunning - if true, interrupt running tasks

Returns:

true if cancellation was successful, false if already cancelled