Module async.generator

Package org.bsc.async

Class AsyncGenerator.WithEmbed<E>

java.lang.Object

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

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

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

Type Parameters:

E - the type of elements in the generator

All Implemented Interfaces:

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

Enclosing interface:

AsyncGenerator<E>

public static class AsyncGenerator.WithEmbed<E>
extends AsyncGenerator.BaseCancellable<E>
implements AsyncGenerator.HasResultValue

An asynchronous generator decorator that allows to generators composition embedding other generators.

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
WithEmbed(AsyncGenerator<E> delegate)
WithEmbed(AsyncGenerator<E> delegate, AsyncGenerator.EmbedCompletionHandler onGeneratorDoneWithResult)

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)	Requests cancellation of the generator.
final Executor	executor()
CompletableFuture<Object>	forEachAsync(Consumer<E> consumer)	Asynchronously iterates over the elements of the AsyncGenerator and applies the given consumer to each element.
Iterator<E>	iterator()	Returns an iterator over the elements of this AsyncGenerator.
AsyncGenerator.Data<E>	next()	Retrieves the next asynchronous element.
<R> CompletableFuture<R>	reduce(R result, BiFunction<R,E,R> reducer)
<R> CompletableFuture<R>	reduceAsync(R result, BiFunction<R,E,R> reducer)
Optional<Object>	resultValue()
Deque<Optional<Object>>	resultValues()
CompletableFuture<Object>	toCompletableFuture()	Converts the AsyncGenerator to a CompletableFuture.
CompletableFuture<Object>	toCompletableFutureAsync()

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

isCancelled

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

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

flatMap, map, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

WithEmbed

public WithEmbed(AsyncGenerator<E> delegate,
 AsyncGenerator.EmbedCompletionHandler onGeneratorDoneWithResult)

WithEmbed

public WithEmbed(AsyncGenerator<E> delegate)

Method Details

executor

public final Executor executor()

Specified by:

executor in interface AsyncGenerator<E>

Overrides:

executor in class AsyncGenerator.Base<E>

resultValues

public Deque<Optional<Object>> resultValues()

resultValue

public Optional<Object> resultValue()

Specified by:

resultValue in interface AsyncGenerator.HasResultValue

next

public AsyncGenerator.Data<E> next()

Description copied from interface: AsyncGenerator

Retrieves the next asynchronous element.

Specified by:

next in interface AsyncGenerator<E>

Returns:

the next element from the generator

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

iterator

public Iterator<E> iterator()

Description copied from interface: AsyncGenerator

Returns an iterator over the elements of this AsyncGenerator. Each call to `next` retrieves the next "resolved" asynchronous element from the generator.

Specified by:

iterator in interface AsyncGenerator<E>

Specified by:

iterator in interface Iterable<E>

Returns:

an iterator over the elements of this AsyncGenerator

forEachAsync

public CompletableFuture<Object> forEachAsync(Consumer<E> consumer)

Description copied from interface: AsyncGenerator

Asynchronously iterates over the elements of the AsyncGenerator and applies the given consumer to each element.

Specified by:

forEachAsync in interface AsyncGenerator<E>

Parameters:

consumer - the consumer function to be applied to each element

Returns:

a CompletableFuture representing the completion of the iteration process.

reduce

public <R> CompletableFuture<R> reduce(R result,
 BiFunction<R,E,R> reducer)

Specified by:

reduce in interface AsyncGenerator<E>

reduceAsync

public <R> CompletableFuture<R> reduceAsync(R result,
 BiFunction<R,E,R> reducer)

Specified by:

reduceAsync in interface AsyncGenerator<E>

toCompletableFuture

public CompletableFuture<Object> toCompletableFuture()

Description copied from interface: AsyncGenerator

Converts the AsyncGenerator to a CompletableFuture.

Specified by:

toCompletableFuture in interface AsyncGenerator<E>

Returns:

a CompletableFuture representing the completion of the AsyncGenerator

toCompletableFutureAsync

public CompletableFuture<Object> toCompletableFutureAsync()

Specified by:

toCompletableFutureAsync in interface AsyncGenerator<E>