Module async.generator

Package org.bsc.async

Class AsyncGenerator.WithResult<E>

java.lang.Object

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

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

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

Type Parameters:

E - the type of elements in the generator

All Implemented Interfaces:

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

Enclosing interface:

AsyncGenerator<E>

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

An asynchronous generator decorator that allows retrieving the result value of the asynchronous operation, if any.

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
WithResult(AsyncGenerator<E> delegate)

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)	method that request to cancel generator
AsyncGenerator<E>	delegate()
Executor	executor()
AsyncGenerator.Data<E>	next()	Retrieves the next asynchronous element.
Optional<Object>	resultValue()	Retrieves the result value of the generator, if any.

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

isCancelled

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, forEachAsync, iterator, map, reduce, reduceAsync, stream, toCompletableFuture

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

WithResult

public WithResult(AsyncGenerator<E> delegate)

Method Details

delegate

public AsyncGenerator<E> delegate()

executor

public Executor executor()

Specified by:

executor in interface AsyncGenerator<E>

Overrides:

executor in class AsyncGenerator.Base<E>

resultValue

public Optional<Object> resultValue()

Retrieves the result value of the generator, if any.

Specified by:

resultValue in interface AsyncGenerator.HasResultValue

Returns:

an Optional containing the result value if present, or an empty Optional if not

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 interface: AsyncGenerator.IsCancellable

method that request to cancel generator

Specified by:

cancel in interface AsyncGenerator.IsCancellable

Overrides:

cancel in class AsyncGenerator.BaseCancellable<E>