net.tascalate.concurrent

Interface Promise<T>

Type Parameters:

T - a type of the successfully resolved promise value

All Superinterfaces:

CompletionStage<T>, Future<T>

All Known Subinterfaces:

DependentPromise<T>, RunnablePromise<T>

All Known Implementing Classes:

AbstractDependentPromiseDecorator, AbstractPromiseDecorator, AsyncCountDownLatch, BlockingCompletionStageDecorator, CompletableFutureDecorator, CompletableFutureWrapper, CompletablePromise, CompletableTask, CompletionStageWrapper, ConfigurableDependentPromise, CustomizableDependentPromiseDecorator, CustomizablePromiseDecorator, ExecutorBoundDependentPromise, ExecutorBoundPromise, ExtendedDependentPromiseDecorator, ExtendedPromiseDecorator, PromiseAdapter

public interface Promise<T>
extends Future<T>, CompletionStage<T>

Promise is a combination of the CompletionStage and Future contracts. It provides both composition methods of the former and blocking access methods of the later.

Every composition method derived from the CompletionStage interface is overridden to return a new Promise;

Author:

vsilaev

Method Summary

Modifier and Type	Method and Description
Promise<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
Promise<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
Promise<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> Promise<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> Promise<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> Promise<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
default <D> D	as(Function<? super Promise<T>,D> decoratorFactory) Decorate this Promise with a decorator specified
default Promise<T>	defaultAsyncOn(Executor executor)
default Promise<T>	delay(Duration duration)
default Promise<T>	delay(Duration duration, boolean delayOnError)
default Promise<T>	delay(long timeout, TimeUnit unit)
default Promise<T>	delay(long timeout, TimeUnit unit, boolean delayOnError)
default DependentPromise<T>	dependent() Converts this Promise to a DependentPromise The returned DependentPromise does not implicitly enlist any CompletionStage for cancellation (neither self, nor passed as arguments to combining methods); only enlisting via explicit parameter is supported
default DependentPromise<T>	dependent(Set<PromiseOrigin> defaultEnlistOptions) Converts this Promise to a DependentPromise The returned DependentPromise does implicitly enlist CompletionStage for cancellation (either self, and/or passed as arguments to combining methods) according to defaultEnlistOptions parameter
Promise<T>	exceptionally(Function<Throwable,? extends T> fn)
default Promise<T>	exceptionallyAsync(Function<Throwable,? extends T> fn)
default Promise<T>	exceptionallyAsync(Function<Throwable,? extends T> fn, Executor executor)
default Promise<T>	exceptionallyCompose(Function<Throwable,? extends CompletionStage<T>> fn)
default Promise<T>	exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn)
default Promise<T>	exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn, Executor executor)
default T	getNow(Supplier<? extends T> valueIfAbsent)
default T	getNow(T valueIfAbsent)
<U> Promise<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> Promise<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
<U> Promise<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
default boolean	isCompletedExceptionally()
default T	join()
default Promise<T>	onCancel(Runnable action)
default Promise<T>	onTimeout(Supplier<? extends T> supplier, Duration duration)
default Promise<T>	onTimeout(Supplier<? extends T> supplier, Duration duration, boolean cancelOnTimeout)
default Promise<T>	onTimeout(Supplier<? extends T> supplier, long timeout, TimeUnit unit)
default Promise<T>	onTimeout(Supplier<? extends T> supplier, long timeout, TimeUnit unit, boolean cancelOnTimeout)
default Promise<T>	onTimeout(T value, Duration duration)
default Promise<T>	onTimeout(T value, Duration duration, boolean cancelOnTimeout)
default Promise<T>	onTimeout(T value, long timeout, TimeUnit unit)
default Promise<T>	onTimeout(T value, long timeout, TimeUnit unit, boolean cancelOnTimeout)
default Promise<T>	orTimeout(Duration duration)
default Promise<T>	orTimeout(Duration duration, boolean cancelOnTimeout)
default Promise<T>	orTimeout(long timeout, TimeUnit unit)
default Promise<T>	orTimeout(long timeout, TimeUnit unit, boolean cancelOnTimeout)
default Promise<T>	raw() Fully unwraps underlying Promise (removes all decoration layers)
Promise<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
Promise<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
Promise<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
Promise<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
Promise<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
Promise<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
Promise<Void>	thenAccept(Consumer<? super T> action)
Promise<Void>	thenAcceptAsync(Consumer<? super T> action)
Promise<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> Promise<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> Promise<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> Promise<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> Promise<U>	thenApply(Function<? super T,? extends U> fn)
<U> Promise<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> Promise<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U,V> Promise<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> Promise<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> Promise<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> Promise<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> Promise<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> Promise<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
default Promise<T>	thenFilter(Predicate<? super T> predicate)
default Promise<T>	thenFilter(Predicate<? super T> predicate, Function<? super T,Throwable> errorSupplier)
default Promise<T>	thenFilterAsync(Predicate<? super T> predicate)
default Promise<T>	thenFilterAsync(Predicate<? super T> predicate, Executor executor)
default Promise<T>	thenFilterAsync(Predicate<? super T> predicate, Function<? super T,Throwable> errorSupplier)
default Promise<T>	thenFilterAsync(Predicate<? super T> predicate, Function<? super T,Throwable> errorSupplier, Executor executor)
Promise<Void>	thenRun(Runnable action)
Promise<Void>	thenRunAsync(Runnable action)
Promise<Void>	thenRunAsync(Runnable action, Executor executor)
default Promise<T>	unwrap() Unwraps underlying Promise if it was decorated (removes one level of decorators)
Promise<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
Promise<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
Promise<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface java.util.concurrent.CompletionStage

toCompletableFuture

Method Detail

getNow

default T getNow(T valueIfAbsent)
          throws CancellationException,
                 CompletionException

Throws:

CancellationException

CompletionException

getNow

default T getNow(Supplier<? extends T> valueIfAbsent)
          throws CancellationException,
                 CompletionException

Throws:

CancellationException

CompletionException

join

default T join()
        throws CancellationException,
               CompletionException

Throws:

CancellationException

CompletionException

isCompletedExceptionally

default boolean isCompletedExceptionally()

onCancel

default Promise<T> onCancel(Runnable action)

delay

default Promise<T> delay(long timeout,
                         TimeUnit unit)

delay

default Promise<T> delay(long timeout,
                         TimeUnit unit,
                         boolean delayOnError)

delay

default Promise<T> delay(Duration duration)

delay

default Promise<T> delay(Duration duration,
                         boolean delayOnError)

orTimeout

default Promise<T> orTimeout(long timeout,
                             TimeUnit unit)

orTimeout

default Promise<T> orTimeout(long timeout,
                             TimeUnit unit,
                             boolean cancelOnTimeout)

orTimeout

default Promise<T> orTimeout(Duration duration)

orTimeout

default Promise<T> orTimeout(Duration duration,
                             boolean cancelOnTimeout)

onTimeout

default Promise<T> onTimeout(T value,
                             long timeout,
                             TimeUnit unit)

onTimeout

default Promise<T> onTimeout(T value,
                             long timeout,
                             TimeUnit unit,
                             boolean cancelOnTimeout)

onTimeout

default Promise<T> onTimeout(T value,
                             Duration duration)

onTimeout

default Promise<T> onTimeout(T value,
                             Duration duration,
                             boolean cancelOnTimeout)

onTimeout

default Promise<T> onTimeout(Supplier<? extends T> supplier,
                             long timeout,
                             TimeUnit unit)

onTimeout

default Promise<T> onTimeout(Supplier<? extends T> supplier,
                             long timeout,
                             TimeUnit unit,
                             boolean cancelOnTimeout)

onTimeout

default Promise<T> onTimeout(Supplier<? extends T> supplier,
                             Duration duration)

onTimeout

default Promise<T> onTimeout(Supplier<? extends T> supplier,
                             Duration duration,
                             boolean cancelOnTimeout)

dependent

default DependentPromise<T> dependent()

Converts this Promise to a DependentPromise The returned DependentPromise does not implicitly enlist any CompletionStage for cancellation (neither self, nor passed as arguments to combining methods); only enlisting via explicit parameter is supported

Returns:

created DependentPromise

dependent

default DependentPromise<T> dependent(Set<PromiseOrigin> defaultEnlistOptions)

Converts this Promise to a DependentPromise The returned DependentPromise does implicitly enlist CompletionStage for cancellation (either self, and/or passed as arguments to combining methods) according to defaultEnlistOptions parameter

Parameters:

defaultEnlistOptions - defines what CompletionStage should be enlisted implicitly for cancellation

Returns:

created DependentPromise

defaultAsyncOn

default Promise<T> defaultAsyncOn(Executor executor)

as

default <D> D as(Function<? super Promise<T>,D> decoratorFactory)

Decorate this Promise with a decorator specified

Type Parameters:

D - type of the actual promise decorator

Parameters:

decoratorFactory - a factory to create a concrete decorator

Returns:

a decorator created

unwrap

default Promise<T> unwrap()

Unwraps underlying Promise if it was decorated (removes one level of decorators)

Returns:

the underlying un-decorated Promise or self if not decorated

raw

default Promise<T> raw()

Fully unwraps underlying Promise (removes all decoration layers)

Returns:

the underlying un-decorated Promise or self if not decorated

thenApply

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

Specified by:

thenApply in interface CompletionStage<T>

thenApplyAsync

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

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApplyAsync

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

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenAccept

Promise<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

thenAcceptAsync

Promise<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAcceptAsync

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

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenRun

Promise<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

thenRunAsync

Promise<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRunAsync

Promise<Void> thenRunAsync(Runnable action,
                           Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenCombine

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

Specified by:

thenCombine in interface CompletionStage<T>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenAcceptBoth

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

Specified by:

thenAcceptBoth in interface CompletionStage<T>

thenAcceptBothAsync

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

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBothAsync

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

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

runAfterBoth

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

Specified by:

runAfterBoth in interface CompletionStage<T>

runAfterBothAsync

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

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBothAsync

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

Specified by:

runAfterBothAsync in interface CompletionStage<T>

applyToEither

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

Specified by:

applyToEither in interface CompletionStage<T>

applyToEitherAsync

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

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEitherAsync

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

Specified by:

applyToEitherAsync in interface CompletionStage<T>

acceptEither

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

Specified by:

acceptEither in interface CompletionStage<T>

acceptEitherAsync

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

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEitherAsync

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

Specified by:

acceptEitherAsync in interface CompletionStage<T>

runAfterEither

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

Specified by:

runAfterEither in interface CompletionStage<T>

runAfterEitherAsync

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

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEitherAsync

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

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

thenCompose

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

Specified by:

thenCompose in interface CompletionStage<T>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<T>

exceptionally

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

Specified by:

exceptionally in interface CompletionStage<T>

exceptionallyAsync

default Promise<T> exceptionallyAsync(Function<Throwable,? extends T> fn)

exceptionallyAsync

default Promise<T> exceptionallyAsync(Function<Throwable,? extends T> fn,
                                      Executor executor)

exceptionallyCompose

default Promise<T> exceptionallyCompose(Function<Throwable,? extends CompletionStage<T>> fn)

exceptionallyComposeAsync

default Promise<T> exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn)

exceptionallyComposeAsync

default Promise<T> exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn,
                                             Executor executor)

thenFilter

default Promise<T> thenFilter(Predicate<? super T> predicate)

thenFilter

default Promise<T> thenFilter(Predicate<? super T> predicate,
                              Function<? super T,Throwable> errorSupplier)

thenFilterAsync

default Promise<T> thenFilterAsync(Predicate<? super T> predicate)

thenFilterAsync

default Promise<T> thenFilterAsync(Predicate<? super T> predicate,
                                   Function<? super T,Throwable> errorSupplier)

thenFilterAsync

default Promise<T> thenFilterAsync(Predicate<? super T> predicate,
                                   Executor executor)

thenFilterAsync

default Promise<T> thenFilterAsync(Predicate<? super T> predicate,
                                   Function<? super T,Throwable> errorSupplier,
                                   Executor executor)

whenComplete

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

Specified by:

whenComplete in interface CompletionStage<T>

whenCompleteAsync

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

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenCompleteAsync

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

Specified by:

whenCompleteAsync in interface CompletionStage<T>

handle

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

Specified by:

handle in interface CompletionStage<T>

handleAsync

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

Specified by:

handleAsync in interface CompletionStage<T>

handleAsync

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

Specified by:

handleAsync in interface CompletionStage<T>