Package org.opendaylight.infrautils.utils.concurrent

Class CompletionStageWrapper<T>

java.lang.Object

org.opendaylight.infrautils.utils.concurrent.CompletionStageWrapper<T>

All Implemented Interfaces:

CompletionStage<T>

public final class CompletionStageWrapper<T>
extends Object
implements CompletionStage<T>

CompletionStage wrapper which hides the implementation (e.g. such as, typically, a CompletableFuture) to prevent consumers from casting (or using CompletionStage.toCompletableFuture()) and accessing methods for "forcibly completing normally or exceptionally, probing completion status or results, or awaiting completion of a stage" (which e.g. CompletableFuture offers, but CompletionStage intentionally does not).

This is mainly intended to let methods return CompletionStages which internally were CompletableFutures, yet prevent developers from abusing such async APIs by using them synchronously and just doing completionStage.toCompletableFuture().get() (or ((CompletableFuture)completionStage).get()).

Author:

Michael Vorburger.ch

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> CompletionStage<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> CompletionStage<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> CompletionStage<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
CompletionStage<T>	exceptionally(Function<Throwable,? extends T> fn)
<U> CompletionStage<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> CompletionStage<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
<U> CompletionStage<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
CompletionStage<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionStage<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionStage<Void>	thenAccept(Consumer<? super T> action)
CompletionStage<Void>	thenAcceptAsync(Consumer<? super T> action)
CompletionStage<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> CompletionStage<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> CompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> CompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> CompletionStage<U>	thenApply(Function<? super T,? extends U> fn)
<U> CompletionStage<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> CompletionStage<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U,V> CompletionStage<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> CompletionStage<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> CompletionStage<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> CompletionStage<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> CompletionStage<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> CompletionStage<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
CompletionStage<Void>	thenRun(Runnable action)
CompletionStage<Void>	thenRunAsync(Runnable action)
CompletionStage<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<T>	toCompletableFuture()
CompletionStage<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
CompletionStage<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
CompletionStage<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)
static <T> CompletionStage<T>	wrap(CompletionStage<T> completionStageToWrap)

Methods inherited from class java.lang.Object

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

Method Detail

wrap

public static <T> CompletionStage<T> wrap(CompletionStage<T> completionStageToWrap)

toCompletableFuture

public CompletableFuture<T> toCompletableFuture()

Specified by:

toCompletableFuture in interface CompletionStage<T>

thenApply

public <U> CompletionStage<U> thenApply(Function<? super T,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<T>

thenApplyAsync

public <U> CompletionStage<U> thenApplyAsync(Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApplyAsync

public <U> CompletionStage<U> thenApplyAsync(Function<? super T,? extends U> fn,
                                             Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenAccept

public CompletionStage<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

thenAcceptAsync

public CompletionStage<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAcceptAsync

public CompletionStage<Void> thenAcceptAsync(Consumer<? super T> action,
                                             Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenRun

public CompletionStage<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

thenRunAsync

public CompletionStage<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRunAsync

public CompletionStage<Void> thenRunAsync(Runnable action,
                                          Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenCombine

public <U,V> CompletionStage<V> thenCombine(CompletionStage<? extends U> other,
                                                  BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface CompletionStage<T>

thenCombineAsync

public <U,V> CompletionStage<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                       BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombineAsync

public <U,V> CompletionStage<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                       BiFunction<? super T,? super U,? extends V> fn,
                                                       Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenAcceptBoth

public <U> CompletionStage<Void> thenAcceptBoth(CompletionStage<? extends U> other,
                                                BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

thenAcceptBothAsync

public <U> CompletionStage<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                     BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBothAsync

public <U> CompletionStage<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                     BiConsumer<? super T,? super U> action,
                                                     Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

runAfterBoth

public CompletionStage<Void> runAfterBoth(CompletionStage<?> other,
                                          Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<T>

runAfterBothAsync

public CompletionStage<Void> runAfterBothAsync(CompletionStage<?> other,
                                               Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBothAsync

public CompletionStage<Void> runAfterBothAsync(CompletionStage<?> other,
                                               Runnable action,
                                               Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

applyToEither

public <U> CompletionStage<U> applyToEither(CompletionStage<? extends T> other,
                                            Function<? super T,U> fn)

Specified by:

applyToEither in interface CompletionStage<T>

applyToEitherAsync

public <U> CompletionStage<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                                 Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEitherAsync

public <U> CompletionStage<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                                 Function<? super T,U> fn,
                                                 Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

acceptEither

public CompletionStage<Void> acceptEither(CompletionStage<? extends T> other,
                                          Consumer<? super T> action)

Specified by:

acceptEither in interface CompletionStage<T>

acceptEitherAsync

public CompletionStage<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                               Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEitherAsync

public CompletionStage<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                               Consumer<? super T> action,
                                               Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

runAfterEither

public CompletionStage<Void> runAfterEither(CompletionStage<?> other,
                                            Runnable action)

Specified by:

runAfterEither in interface CompletionStage<T>

runAfterEitherAsync

public CompletionStage<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                 Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEitherAsync

public CompletionStage<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                 Runnable action,
                                                 Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

thenCompose

public <U> CompletionStage<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<T>

thenComposeAsync

public <U> CompletionStage<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenComposeAsync

public <U> CompletionStage<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn,
                                               Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<T>

exceptionally

public CompletionStage<T> exceptionally(Function<Throwable,? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

whenComplete

public CompletionStage<T> whenComplete(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<T>

whenCompleteAsync

public CompletionStage<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenCompleteAsync

public CompletionStage<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action,
                                            Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

handle

public <U> CompletionStage<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

handleAsync

public <U> CompletionStage<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<T>

handleAsync

public <U> CompletionStage<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
                                          Executor executor)

Specified by:

handleAsync in interface CompletionStage<T>