Class CompletionSingle<T>

java.lang.Object

io.helidon.common.reactive.CompletionAwaitable<T>

io.helidon.common.reactive.CompletionSingle<T>

Type Parameters:

T - payload type

All Implemented Interfaces:

Awaitable<T>, Single<T>, Subscribable<T>, CompletionStage<T>, Flow.Publisher<T>

public abstract class CompletionSingle<T>
extends CompletionAwaitable<T>
implements Single<T>

Single as CompletionStage.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompletionSingle()	Create a new completion single using toNullableStage() as a supplier for CompletionAwaitable.setOriginalStage(java.util.function.Supplier).

Method Summary

Modifier and Type	Method	Description
Single<T>	cancel()	Cancel upstream.
Single<T>	onCancel(Runnable onCancel)	Executes given Runnable when a cancel signal is received.
protected CompletableFuture<T>	toNullableStage()	Create a new nullable completable future from this single.

Methods inherited from class CompletionAwaitable

acceptEither, acceptEitherAsync, acceptEitherAsync, applyToEither, applyToEitherAsync, applyToEitherAsync, exceptionally, exceptionallyAccept, handle, handleAsync, handleAsync, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, whenComplete, whenCompleteAsync, whenCompleteAsync

Modifier and Type	Method	Description
CompletionAwaitable<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionAwaitable<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionAwaitable<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> CompletionAwaitable<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T, U> fn)
<U> CompletionAwaitable<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn)
<U> CompletionAwaitable<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn, Executor executor)
CompletionAwaitable<T>	exceptionally(Function<Throwable, ? extends T> fn)
CompletionAwaitable<T>	exceptionallyAccept(Consumer<Throwable> consumer)	Returns a new CompletionAwaitable that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied consumer.
<U> CompletionAwaitable<U>	handle(BiFunction<? super T, Throwable, ? extends U> fn)
<U> CompletionAwaitable<U>	handleAsync(BiFunction<? super T, Throwable, ? extends U> fn)
<U> CompletionAwaitable<U>	handleAsync(BiFunction<? super T, Throwable, ? extends U> fn, Executor executor)
CompletionAwaitable<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionAwaitable<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionAwaitable<Void>	thenAccept(Consumer<? super T> action)
CompletionAwaitable<Void>	thenAcceptAsync(Consumer<? super T> action)
CompletionAwaitable<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> CompletionAwaitable<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)
<U> CompletionAwaitable<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)
<U> CompletionAwaitable<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action, Executor executor)
<U> CompletionAwaitable<U>	thenApply(Function<? super T, ? extends U> fn)
<U> CompletionAwaitable<U>	thenApplyAsync(Function<? super T, ? extends U> fn)
<U> CompletionAwaitable<U>	thenApplyAsync(Function<? super T, ? extends U> fn, Executor executor)
<U,V> CompletionAwaitable<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn)
<U,V> CompletionAwaitable<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn)
<U,V> CompletionAwaitable<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn, Executor executor)
<U> CompletionAwaitable<U>	thenCompose(Function<? super T, ? extends CompletionStage<U>> fn)
<U> CompletionAwaitable<U>	thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn)
<U> CompletionAwaitable<U>	thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn, Executor executor)
CompletionAwaitable<Void>	thenRun(Runnable action)
CompletionAwaitable<Void>	thenRunAsync(Runnable action)
CompletionAwaitable<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<T>	toCompletableFuture()	Returns a CompletableFuture maintaining the same completion properties as this stage.
CompletionAwaitable<T>	whenComplete(BiConsumer<? super T, ? super Throwable> action)
CompletionAwaitable<T>	whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action)
CompletionAwaitable<T>	whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action, Executor executor)

Methods inherited from class Object

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

Methods inherited from interface Awaitable

await, await, await, toCompletableFuture

Modifier and Type	Method	Description
default T	await()	Block until future is completed, throws only unchecked exceptions.
default T	await(long timeout, TimeUnit unit)	Deprecated. use Awaitable.await(Duration) instead
default T	await(Duration duration)	Block until future is completed, throws only unchecked exceptions.
CompletableFuture<T>	toCompletableFuture()	Returns a CompletableFuture maintaining the same completion properties as this stage.

Methods inherited from interface CompletionStage

exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync

Methods inherited from interface Flow.Publisher

subscribe

Methods inherited from interface Single

acceptEither, acceptEitherAsync, acceptEitherAsync, applyToEither, applyToEitherAsync, applyToEitherAsync, compose, defaultIfEmpty, defaultIfEmpty, exceptionally, exceptionallyAccept, flatMap, flatMapCompletionStage, flatMapIterable, flatMapOptional, flatMapSingle, forSingle, get, get, handle, handleAsync, handleAsync, ifEmpty, ignoreElement, log, log, log, log, map, observeOn, onComplete, onCompleteResume, onCompleteResumeWith, onCompleteResumeWithSingle, onError, onErrorResume, onErrorResumeWith, onErrorResumeWithSingle, onTerminate, peek, retry, retry, retryWhen, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, switchIfEmpty, takeUntil, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, timeout, timeout, to, toOptionalSingle, toStage, toStage, whenComplete, whenCompleteAsync, whenCompleteAsync

Modifier and Type	Method	Description
CompletionAwaitable<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionAwaitable<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionAwaitable<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> CompletionAwaitable<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T, U> fn)
<U> CompletionAwaitable<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn)
<U> CompletionAwaitable<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn, Executor executor)
default <U> Single<U>	compose(Function<? super Single<T>, ? extends Single<? extends U>> composer)	Apply the given composer function to the current Single instance and return the Single returned by this function.
default Single<T>	defaultIfEmpty(Supplier<? extends T> supplier)	Signals the default item supplied by specified supplier if the upstream is empty.
default Single<T>	defaultIfEmpty(T defaultItem)	Signals the default item if the upstream is empty.
CompletionAwaitable<T>	exceptionally(Function<Throwable, ? extends T> fn)
CompletionAwaitable<T>	exceptionallyAccept(Consumer<Throwable> consumer)	Returns a new CompletionAwaitable that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied consumer.
default <U> Multi<U>	flatMap(Function<? super T, ? extends Flow.Publisher<? extends U>> mapper)	Map this Single instance to a publisher using the given mapper.
default <U> Single<U>	flatMapCompletionStage(Function<? super T, ? extends CompletionStage<? extends U>> mapper)	Transforms item with supplied function and flatten resulting CompletionStage result to downstream.
default <U> Multi<U>	flatMapIterable(Function<? super T, ? extends Iterable<? extends U>> mapper)	Maps the single upstream value into an Iterable and relays its items to the downstream.
default <U> Single<U>	flatMapOptional(Function<? super T, Optional<? extends U>> mapper)	Transform item with supplied function and flatten resulting Optional to downstream as Single with its value as item if present or empty Single.
default <U> Single<U>	flatMapSingle(Function<? super T, ? extends Single<? extends U>> mapper)	Transforms item with supplied function and flatten resulting Single to downstream.
default CompletionAwaitable<Void>	forSingle(Consumer<T> consumer)	Terminal stage, invokes provided consumer when Single is completed.
default T	get()	Short-hand for toFuture().toCompletableFuture().get().
default T	get(long timeout, TimeUnit unit)	Short-hand for toFuture().toCompletableFuture().get().
<U> CompletionAwaitable<U>	handle(BiFunction<? super T, Throwable, ? extends U> fn)
<U> CompletionAwaitable<U>	handleAsync(BiFunction<? super T, Throwable, ? extends U> fn)
<U> CompletionAwaitable<U>	handleAsync(BiFunction<? super T, Throwable, ? extends U> fn, Executor executor)
default Single<T>	ifEmpty(Runnable ifEmpty)	Executes given Runnable when stream is finished without value(empty stream).
default CompletionAwaitable<Void>	ignoreElement()	Terminal stage, ignore onNext signals, only onComplete and onError signals are propagated.
default Single<T>	log()	Log all signals onSubscribe, onNext, onError, onComplete, cancel and request coming to and from preceding operator.
default Single<T>	log(Level level)	Log all signals onSubscribe, onNext, onError, onComplete, cancel and request coming to and from preceding operator.
default Single<T>	log(Level level, boolean trace)	Log all signals onSubscribe, onNext, onError, onComplete, cancel and request coming to and from preceding operator.
default Single<T>	log(Level level, String loggerName)	Log all signals onSubscribe, onNext, onError, onComplete, cancel and request coming to and from preceding operator.
default <U> Single<U>	map(Function<? super T, ? extends U> mapper)	Map this Single instance to a new Single of another type using the given Function.
default Single<T>	observeOn(Executor executor)	Re-emit the upstream's signals to the downstream on the given executor's thread.
default Single<T>	onComplete(Runnable onComplete)	Executes given Runnable when onComplete signal is received.
default Multi<T>	onCompleteResume(T item)	Resume stream from single item if onComplete signal is intercepted.
default Multi<T>	onCompleteResumeWith(Flow.Publisher<? extends T> publisher)	Resume stream from supplied publisher if onComplete signal is intercepted.
default Single<T>	onCompleteResumeWithSingle(Function<Optional<T>, ? extends Single<? extends T>> onComplete)	Resume stream with supplied single if onComplete signal is intercepted.
default Single<T>	onError(Consumer<? super Throwable> onErrorConsumer)	Executes given Consumer when onError signal is received.
default Single<T>	onErrorResume(Function<? super Throwable, ? extends T> onError)	Function providing one item to be submitted as onNext in case of onError signal is received.
default Multi<T>	onErrorResumeWith(Function<? super Throwable, ? extends Flow.Publisher<? extends T>> onError)	Resume stream from supplied publisher if onError signal is intercepted.
default Single<T>	onErrorResumeWithSingle(Function<? super Throwable, ? extends Single<? extends T>> onError)	Resume stream from supplied publisher if onError signal is intercepted.
default Single<T>	onTerminate(Runnable onTerminate)	Executes given Runnable when any of signals onComplete, onCancel or onError is received.
default Single<T>	peek(Consumer<? super T> consumer)	Invoke provided consumer for the item in stream.
default Single<T>	retry(long count)	Retry a failing upstream at most the given number of times before giving up.
default Single<T>	retry(BiPredicate<? super Throwable, ? super Long> predicate)	Retry a failing upstream if the predicate returns true.
default <U> Single<T>	retryWhen(BiFunction<? super Throwable, ? super Long, ? extends Flow.Publisher<U>> whenFunction)	Retry a failing upstream when the given function returns a publisher that signals an item.
CompletionAwaitable<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionAwaitable<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
CompletionAwaitable<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
default Single<T>	switchIfEmpty(Single<T> other)	Switch to the other Single if the upstream is empty.
default <U> Single<T>	takeUntil(Flow.Publisher<U> other)	Relay upstream items until the other source signals an item or completes.
CompletionAwaitable<Void>	thenAccept(Consumer<? super T> action)
CompletionAwaitable<Void>	thenAcceptAsync(Consumer<? super T> action)
CompletionAwaitable<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> CompletionAwaitable<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)
<U> CompletionAwaitable<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)
<U> CompletionAwaitable<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action, Executor executor)
<U> CompletionAwaitable<U>	thenApply(Function<? super T, ? extends U> fn)
<U> CompletionAwaitable<U>	thenApplyAsync(Function<? super T, ? extends U> fn)
<U> CompletionAwaitable<U>	thenApplyAsync(Function<? super T, ? extends U> fn, Executor executor)
<U,V> CompletionAwaitable<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn)
<U,V> CompletionAwaitable<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn)
<U,V> CompletionAwaitable<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn, Executor executor)
<U> CompletionAwaitable<U>	thenCompose(Function<? super T, ? extends CompletionStage<U>> fn)
<U> CompletionAwaitable<U>	thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn)
<U> CompletionAwaitable<U>	thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn, Executor executor)
CompletionAwaitable<Void>	thenRun(Runnable action)
CompletionAwaitable<Void>	thenRunAsync(Runnable action)
CompletionAwaitable<Void>	thenRunAsync(Runnable action, Executor executor)
default Single<T>	timeout(long timeout, TimeUnit unit, ScheduledExecutorService executor)	Signals a TimeoutException if the upstream doesn't signal an item, error or completion within the specified time.
default Single<T>	timeout(long timeout, TimeUnit unit, ScheduledExecutorService executor, Single<T> fallback)	Switches to a fallback single if the upstream doesn't signal an item, error or completion within the specified time.
default <U> U	to(Function<? super Single<T>, ? extends U> converter)	Apply the given converter function to the current Single instance and return the value returned by this function.
default Single<Optional<T>>	toOptionalSingle()	Exposes this Single instance as a Single with Optional<T> return type of the asynchronous operation.
default CompletionStage<T>	toStage()	Exposes this Single instance as a CompletionStage.
default CompletionStage<T>	toStage(boolean completeWithoutValue)	Exposes this Single instance as a CompletionStage.
CompletionAwaitable<T>	whenComplete(BiConsumer<? super T, ? super Throwable> action)
CompletionAwaitable<T>	whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action)
CompletionAwaitable<T>	whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action, Executor executor)

Methods inherited from interface Subscribable

subscribe, subscribe, subscribe, subscribe

Modifier and Type	Method	Description
default void	subscribe(Consumer<? super T> consumer)	Subscribe to this Single instance with the given delegate functions.
default void	subscribe(Consumer<? super T> consumer, Consumer<? super Throwable> errorConsumer)	Subscribe to this Single instance with the given delegate functions.
default void	subscribe(Consumer<? super T> consumer, Consumer<? super Throwable> errorConsumer, Runnable completeConsumer)	Subscribe to this Single instance with the given delegate functions.
default void	subscribe(Consumer<? super T> consumer, Consumer<? super Throwable> errorConsumer, Runnable completeConsumer, Consumer<? super Flow.Subscription> subscriptionConsumer)	Subscribe to this Single instance with the given delegate functions.

Constructor Details

CompletionSingle

protected CompletionSingle()

Create a new completion single using toNullableStage() as a supplier for CompletionAwaitable.setOriginalStage(java.util.function.Supplier).

Method Details

toNullableStage

protected CompletableFuture<T> toNullableStage()

Create a new nullable completable future from this single.

Returns:

a new nullable completable future

onCancel

public Single<T> onCancel(Runnable onCancel)

Description copied from interface: Single

Executes given Runnable when a cancel signal is received.

Specified by:

onCancel in interface Single<T>

Specified by:

onCancel in interface Subscribable<T>

Parameters:

onCancel - Runnable to be executed.

Returns:

Single

cancel

public Single<T> cancel()

Description copied from interface: Single

Cancel upstream.

Specified by:

cancel in interface Single<T>

Returns:

new Single for eventually received single value.