Package nl.talsmasoftware.context.futures

Class ContextAwareCompletableFuture<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

nl.talsmasoftware.context.futures.ContextAwareCompletableFuture<T>

public class ContextAwareCompletableFuture<T>
extends java.util.concurrent.CompletableFuture<T>

This class extends the standard CompletableFuture that was introduced in java version 8.

The class is a 'normal' Completable Future, but every successive call made on the result will be made within the context during creation of this ContextAwareCompletableFuture.

Author:

Sjoerd Talsma

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

java.util.concurrent.CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
ContextAwareCompletableFuture()	Creates a new ContextSnapshot and remembers that in this completable future, running all completion methods within this snapshot.
ContextAwareCompletableFuture(ContextSnapshot snapshot)	Creates a new CompletableFuture where all completion methods are run within the specified snapshot context.

Method Summary

Modifier and Type	Method	Description
ContextAwareCompletableFuture<java.lang.Void>	acceptEither(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Consumer<? super T> action)
ContextAwareCompletableFuture<java.lang.Void>	acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Consumer<? super T> action)
ContextAwareCompletableFuture<java.lang.Void>	acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Consumer<? super T> action, java.util.concurrent.Executor executor)
static ContextAwareCompletableFuture<java.lang.Void>	allOf(java.util.concurrent.CompletableFuture<?>... cfs)	Returns a new CompletableFuture that is completed when all of the given CompletableFutures complete.
static ContextAwareCompletableFuture<java.lang.Void>	allOf(ContextSnapshot snapshot, java.util.concurrent.CompletableFuture<?>... cfs)	Returns a new CompletableFuture that is completed when all of the given CompletableFutures complete.
static ContextAwareCompletableFuture<java.lang.Object>	anyOf(java.util.concurrent.CompletableFuture<?>... cfs)	Returns a new CompletableFuture that is completed when any of the given CompletableFutures complete, with the same result.
static ContextAwareCompletableFuture<java.lang.Object>	anyOf(ContextSnapshot snapshot, java.util.concurrent.CompletableFuture<?>... cfs)	Returns a new CompletableFuture that is completed when any of the given CompletableFutures complete, with the same result.
<U> ContextAwareCompletableFuture<U>	applyToEither(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Function<? super T,U> fn)
<U> ContextAwareCompletableFuture<U>	applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Function<? super T,U> fn)
<U> ContextAwareCompletableFuture<U>	applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Function<? super T,U> fn, java.util.concurrent.Executor executor)
static <U> ContextAwareCompletableFuture<U>	completedFuture(U value)	Creates a new ContextAwareCompletableFuture from the already-completed value.
static <U> ContextAwareCompletableFuture<U>	completedFuture(U value, ContextSnapshot snapshot)	Creates a new ContextAwareCompletableFuture from the already-completed value.
static <U> java.util.concurrent.CompletionStage<U>	completedStage(U value)	Creates a new CompletionStage from the already-completed value.
ContextAwareCompletableFuture<T>	exceptionally(java.util.function.Function<java.lang.Throwable,? extends T> fn)
static <U> ContextAwareCompletableFuture<U>	failedFuture(java.lang.Throwable ex)	Creates a new ContextAwareCompletableFuture that is already completed exceptionally with the given exception.
static <U> ContextAwareCompletableFuture<U>	failedFuture(java.lang.Throwable ex, ContextSnapshot snapshot)	Creates a new ContextAwareCompletableFuture that is already completed exceptionally with the given exception.
static <U> java.util.concurrent.CompletionStage<U>	failedStage(java.lang.Throwable ex)	Creates a new CompletionStage that is already completed exceptionally with the given exception.
<U> ContextAwareCompletableFuture<U>	handle(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)
<U> ContextAwareCompletableFuture<U>	handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)
<U> ContextAwareCompletableFuture<U>	handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn, java.util.concurrent.Executor executor)
ContextAwareCompletableFuture<java.lang.Void>	runAfterBoth(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
ContextAwareCompletableFuture<java.lang.Void>	runAfterBothAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
ContextAwareCompletableFuture<java.lang.Void>	runAfterBothAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action, java.util.concurrent.Executor executor)
ContextAwareCompletableFuture<java.lang.Void>	runAfterEither(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
ContextAwareCompletableFuture<java.lang.Void>	runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
ContextAwareCompletableFuture<java.lang.Void>	runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action, java.util.concurrent.Executor executor)
static ContextAwareCompletableFuture<java.lang.Void>	runAsync(java.lang.Runnable runnable)	Runs the runnable task in the common ForkJoinPool within the current context and also applies that context to all successive calls to the CompletableFuture.
static ContextAwareCompletableFuture<java.lang.Void>	runAsync(java.lang.Runnable runnable, java.util.concurrent.Executor executor)	Runs the runnable task in the specified executor within the current context and also applies that context to all successive calls to the CompletableFuture.
static ContextAwareCompletableFuture<java.lang.Void>	runAsync(java.lang.Runnable runnable, java.util.concurrent.Executor executor, ContextSnapshot snapshot)	Runs the runnable task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.
static ContextAwareCompletableFuture<java.lang.Void>	runAsync(java.lang.Runnable runnable, java.util.concurrent.Executor executor, ContextSnapshot snapshot, boolean takeNewSnapshot)	Runs the runnable task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.
static <U> ContextAwareCompletableFuture<U>	supplyAsync(java.util.function.Supplier<U> supplier)	Runs the supplier task in the common ForkJoinPool within the current context and also applies that context to all successive calls to the CompletableFuture.
static <U> ContextAwareCompletableFuture<U>	supplyAsync(java.util.function.Supplier<U> supplier, java.util.concurrent.Executor executor)	Runs the supplier task in the specified executor within the current context and also applies that context to all successive calls to the CompletableFuture.
static <U> ContextAwareCompletableFuture<U>	supplyAsync(java.util.function.Supplier<U> supplier, java.util.concurrent.Executor executor, ContextSnapshot snapshot)	Runs the supplier task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.
static <U> ContextAwareCompletableFuture<U>	supplyAsync(java.util.function.Supplier<U> supplier, java.util.concurrent.Executor executor, ContextSnapshot snapshot, boolean takeNewSnapshot)	Runs the supplier task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.
ContextAwareCompletableFuture<T>	takeNewSnapshot()	Returns a context-aware CompletableFuture that takes a new snapshot after each completion stage.
ContextAwareCompletableFuture<T>	takeNewSnapshot(boolean takeSnapshot)	Returns a context-aware CompletableFuture that may take a new snapshot after each completion stage.
ContextAwareCompletableFuture<java.lang.Void>	thenAccept(java.util.function.Consumer<? super T> action)
ContextAwareCompletableFuture<java.lang.Void>	thenAcceptAsync(java.util.function.Consumer<? super T> action)
ContextAwareCompletableFuture<java.lang.Void>	thenAcceptAsync(java.util.function.Consumer<? super T> action, java.util.concurrent.Executor executor)
<U> ContextAwareCompletableFuture<java.lang.Void>	thenAcceptBoth(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiConsumer<? super T,? super U> action)
<U> ContextAwareCompletableFuture<java.lang.Void>	thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiConsumer<? super T,? super U> action)
<U> ContextAwareCompletableFuture<java.lang.Void>	thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiConsumer<? super T,? super U> action, java.util.concurrent.Executor executor)
<U> ContextAwareCompletableFuture<U>	thenApply(java.util.function.Function<? super T,? extends U> fn)
<U> ContextAwareCompletableFuture<U>	thenApplyAsync(java.util.function.Function<? super T,? extends U> fn)
<U> ContextAwareCompletableFuture<U>	thenApplyAsync(java.util.function.Function<? super T,? extends U> fn, java.util.concurrent.Executor executor)
<U,V> ContextAwareCompletableFuture<V>	thenCombine(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends V> fn)
<U,V> ContextAwareCompletableFuture<V>	thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends V> fn)
<U,V> ContextAwareCompletableFuture<V>	thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends V> fn, java.util.concurrent.Executor executor)
<U> ContextAwareCompletableFuture<U>	thenCompose(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)
<U> ContextAwareCompletableFuture<U>	thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)
<U> ContextAwareCompletableFuture<U>	thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn, java.util.concurrent.Executor executor)
ContextAwareCompletableFuture<java.lang.Void>	thenRun(java.lang.Runnable action)
java.util.concurrent.CompletableFuture<java.lang.Void>	thenRunAsync(java.lang.Runnable action)
ContextAwareCompletableFuture<java.lang.Void>	thenRunAsync(java.lang.Runnable action, java.util.concurrent.Executor executor)
ContextAwareCompletableFuture<T>	whenComplete(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)
ContextAwareCompletableFuture<T>	whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)
ContextAwareCompletableFuture<T>	whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action, java.util.concurrent.Executor executor)

Methods inherited from class java.util.concurrent.CompletableFuture

cancel, complete, completeAsync, completeAsync, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, get, get, getNow, getNumberOfDependents, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, toCompletableFuture, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextAwareCompletableFuture

public ContextAwareCompletableFuture()

Creates a new ContextSnapshot and remembers that in this completable future, running all completion methods within this snapshot.

See Also:

ContextManagers.createContextSnapshot()

ContextAwareCompletableFuture

public ContextAwareCompletableFuture(ContextSnapshot snapshot)

Creates a new CompletableFuture where all completion methods are run within the specified snapshot context.

Parameters:

snapshot - the snapshot to run completion methods in. Optional, the completable future will take a new snaphot if null is provided.

See Also:

ContextManagers.createContextSnapshot()

Method Detail

supplyAsync

public static <U> ContextAwareCompletableFuture<U> supplyAsync(java.util.function.Supplier<U> supplier)

Runs the supplier task in the common ForkJoinPool within the current context and also applies that context to all successive calls to the CompletableFuture.

Type Parameters:

U - the function's return type

Parameters:

supplier - a function to be performed asynchronously returning the result of the CompletableFuture

Returns:

The new CompletableFuture that propagates a snapshot of the current context

See Also:

CompletableFuture.supplyAsync(Supplier), supplyAsync(Supplier, Executor, ContextSnapshot, boolean)

supplyAsync

public static <U> ContextAwareCompletableFuture<U> supplyAsync(java.util.function.Supplier<U> supplier,
                                                               java.util.concurrent.Executor executor)

Runs the supplier task in the specified executor within the current context and also applies that context to all successive calls to the CompletableFuture.

Type Parameters:

U - the function's return type

Parameters:

supplier - a function returning the value to be used to complete the returned CompletableFuture

executor - the executor to use for asynchronous execution

Returns:

The new CompletableFuture that propagates a snapshot of the current context

See Also:

CompletableFuture.supplyAsync(Supplier, Executor), supplyAsync(Supplier, Executor, ContextSnapshot, boolean)

supplyAsync

public static <U> ContextAwareCompletableFuture<U> supplyAsync(java.util.function.Supplier<U> supplier,
                                                               java.util.concurrent.Executor executor,
                                                               ContextSnapshot snapshot)

Runs the supplier task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.

This method is lenient to null values for executor and snapshot:
If executor == null the common ForkJoinPool is used as specified by CompletableFuture.supplyAsync(Supplier).
If snapshot == null a new context snapshot is created for the Supplier (if not already a SupplierWithContext).

Type Parameters:

U - the function's return type

Parameters:

supplier - a function returning the value to be used to complete the returned CompletableFuture

executor - the executor to use for asynchronous execution

snapshot - a snapshot of the context to be propagated in the supplier function and all successive calls of this completable future

Returns:

The new CompletableFuture that propagates the specified context snapshot

See Also:

CompletableFuture.supplyAsync(Supplier, Executor), supplyAsync(Supplier, Executor, ContextSnapshot, boolean)

supplyAsync

public static <U> ContextAwareCompletableFuture<U> supplyAsync(java.util.function.Supplier<U> supplier,
                                                               java.util.concurrent.Executor executor,
                                                               ContextSnapshot snapshot,
                                                               boolean takeNewSnapshot)

Runs the supplier task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.

This method is lenient to null values for executor and snapshot:
If executor == null the common ForkJoinPool is used as specified by CompletableFuture.supplyAsync(Supplier).
If snapshot == null a new context snapshot is created for the Supplier (if not already a SupplierWithContext).

Type Parameters:

U - the function's return type

Parameters:

supplier - a function returning the value to be used to complete the returned CompletableFuture

executor - the executor to use for asynchronous execution

snapshot - a snapshot of the context to be propagated in the supplier function and all successive calls of this completable future

takeNewSnapshot - whether or not a new ContextSnapshot should be taken after the supplier function is done. If false, the snapshot from the caller propagate to all following completion stages. If true, a new snapshot is taken after each completion stage to propagate into the next.

Returns:

The new CompletableFuture that propagates the specified context snapshot

Since:

1.0.4

See Also:

CompletableFuture.supplyAsync(Supplier, Executor)

runAsync

public static ContextAwareCompletableFuture<java.lang.Void> runAsync(java.lang.Runnable runnable)

Runs the runnable task in the common ForkJoinPool within the current context and also applies that context to all successive calls to the CompletableFuture.

Parameters:

runnable - the action to run before completing the returned CompletableFuture

Returns:

The new CompletableFuture that propagates a snapshot of the current context

See Also:

CompletableFuture.runAsync(Runnable), runAsync(Runnable, Executor, ContextSnapshot, boolean)

runAsync

public static ContextAwareCompletableFuture<java.lang.Void> runAsync(java.lang.Runnable runnable,
                                                                     java.util.concurrent.Executor executor)

Runs the runnable task in the specified executor within the current context and also applies that context to all successive calls to the CompletableFuture.

Parameters:

runnable - the action to run before completing the returned CompletableFuture

executor - the executor to use for asynchronous execution

Returns:

The new CompletableFuture that propagates a snapshot of the current context

See Also:

CompletableFuture.runAsync(Runnable, Executor), runAsync(Runnable, Executor, ContextSnapshot, boolean)

runAsync

public static ContextAwareCompletableFuture<java.lang.Void> runAsync(java.lang.Runnable runnable,
                                                                     java.util.concurrent.Executor executor,
                                                                     ContextSnapshot snapshot)

Runs the runnable task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.

This method is lenient to null values for executor and snapshot:
If executor == null the common ForkJoinPool is used as specified by CompletableFuture.supplyAsync(Supplier).
If snapshot == null a new context snapshot is created for the Supplier (if not already a SupplierWithContext).

Parameters:

runnable - the action to run before completing the returned CompletableFuture

executor - the executor to use for asynchronous execution

snapshot - the context snapshot to apply to the runnable action

Returns:

The new CompletableFuture that propagates a snapshot of the current context

See Also:

CompletableFuture.runAsync(Runnable, Executor), runAsync(Runnable, Executor, ContextSnapshot, boolean)

runAsync

public static ContextAwareCompletableFuture<java.lang.Void> runAsync(java.lang.Runnable runnable,
                                                                     java.util.concurrent.Executor executor,
                                                                     ContextSnapshot snapshot,
                                                                     boolean takeNewSnapshot)

Runs the runnable task in the specified executor within the specified context snapshot and also applies that context to all successive calls to the CompletableFuture.

This method is lenient to null values for executor and snapshot:
If executor == null the common ForkJoinPool is used as specified by CompletableFuture.supplyAsync(Supplier).
If snapshot == null a new context snapshot is created for the Supplier (if not already a SupplierWithContext).

Parameters:

runnable - the action to run before completing the returned CompletableFuture

executor - the executor to use for asynchronous execution

snapshot - the context snapshot to apply to the runnable action

takeNewSnapshot - whether or not a new ContextSnapshot should be taken after the supplier function is done. If false, the snapshot from the caller propagate to all following completion stages. If true, a new snapshot is taken after each completion stage to propagate into the next.

Returns:

The new CompletableFuture that propagates a snapshot of the current context

Since:

1.0.4

See Also:

CompletableFuture.runAsync(Runnable, Executor)

completedFuture

public static <U> ContextAwareCompletableFuture<U> completedFuture(U value)

Creates a new ContextAwareCompletableFuture from the already-completed value. A new ContextSnapshot is taken and applied to all following completion stages.

Type Parameters:

U - the type of the value

Parameters:

value - the value to return from the already-completed future.

Returns:

New ContextAwareCompletableFuture returning the completed value and containing a new ContextSnapshot.

Since:

1.0.5

See Also:

completedFuture(Object, ContextSnapshot)

completedFuture

public static <U> ContextAwareCompletableFuture<U> completedFuture(U value,
                                                                   ContextSnapshot snapshot)

Creates a new ContextAwareCompletableFuture from the already-completed value. A new ContextSnapshot is taken and applied to all following completion stages.

Type Parameters:

U - the type of the value

Parameters:

value - the value to return from the already-completed future.

snapshot - the context snapshot to apply to following completion stages (optional, specify null to take a new snapshot)

Returns:

New ContextAwareCompletableFuture returning the completed value and containing the specified ContextSnapshot.

Since:

1.0.5

completedStage

public static <U> java.util.concurrent.CompletionStage<U> completedStage(U value)

Creates a new CompletionStage from the already-completed value. A new ContextSnapshot is taken and applied to all following completion stages.

Type Parameters:

U - the type of the value

Parameters:

value - the value to return from the already-completed stage.

Returns:

New CompletionStage returning the completed value and containing a new ContextSnapshot.

Since:

1.0.5

See Also:

completedFuture(Object, ContextSnapshot)

failedFuture

public static <U> ContextAwareCompletableFuture<U> failedFuture(java.lang.Throwable ex)

Creates a new ContextAwareCompletableFuture that is already completed exceptionally with the given exception. A new ContextSnapshot is taken and applied to all following completion stages.

Type Parameters:

U - the type of the value

Parameters:

ex - the exception

Returns:

New ContextAwareCompletableFuture throwing the exception and containing a new ContextSnapshot.

Since:

1.0.5

See Also:

failedFuture(Throwable, ContextSnapshot)

failedFuture

public static <U> ContextAwareCompletableFuture<U> failedFuture(java.lang.Throwable ex,
                                                                ContextSnapshot snapshot)

Creates a new ContextAwareCompletableFuture that is already completed exceptionally with the given exception. The specified snapshot is applied to all following completion stages.

Type Parameters:

U - the type of the value

Parameters:

ex - the exception

snapshot - the context snapshot to apply to following completion stages (optional, specify null to take a new snapshot)

Returns:

New ContextAwareCompletableFuture throwing the exception and containing the specified snapshot.

Since:

1.0.5

failedStage

public static <U> java.util.concurrent.CompletionStage<U> failedStage(java.lang.Throwable ex)

Creates a new CompletionStage that is already completed exceptionally with the given exception. A new ContextSnapshot is taken and applied to all following completion stages.

Type Parameters:

U - the type of the value

Parameters:

ex - the exception

Returns:

New CompletionStage throwing the exception and containing a new ContextSnapshot.

Since:

1.0.5

See Also:

failedFuture(Throwable, ContextSnapshot)

allOf

public static ContextAwareCompletableFuture<java.lang.Void> allOf(java.util.concurrent.CompletableFuture<?>... cfs)

Returns a new CompletableFuture that is completed when all of the given CompletableFutures complete. If any of the given CompletableFutures complete exceptionally, then the returned CompletableFuture also does so, with a CompletionException holding this exception as its cause. Otherwise, the results, if any, of the given CompletableFutures are not reflected in the returned CompletableFuture, but may be obtained by inspecting them individually. If no CompletableFutures are provided, returns a CompletableFuture completed with the value null.

Among the applications of this method is to await completion of a set of independent CompletableFutures before continuing a program, as in: CompletableFuture.allOf(c1, c2, c3).join();.

A new ContextSnapshot is taken and applied to all following completion stages.

Parameters:

cfs - the CompletableFutures

Returns:

A new ContextAwareCompletableFuture that is completed when all of the given CompletableFutures complete

Throws:

java.lang.NullPointerException - if the array or any of its elements are null

Since:

1.0.5

allOf

public static ContextAwareCompletableFuture<java.lang.Void> allOf(ContextSnapshot snapshot,
                                                                  java.util.concurrent.CompletableFuture<?>... cfs)

Returns a new CompletableFuture that is completed when all of the given CompletableFutures complete. If any of the given CompletableFutures complete exceptionally, then the returned CompletableFuture also does so, with a CompletionException holding this exception as its cause. Otherwise, the results, if any, of the given CompletableFutures are not reflected in the returned CompletableFuture, but may be obtained by inspecting them individually. If no CompletableFutures are provided, returns a CompletableFuture completed with the value null.

Among the applications of this method is to await completion of a set of independent CompletableFutures before continuing a program, as in: CompletableFuture.allOf(c1, c2, c3).join();.

The specified ContextSnapshot is applied to all following completion stages.

Parameters:

snapshot - the context snapshot to apply to following completion stages (optional, specify null to take a new snapshot)

cfs - the CompletableFutures

Returns:

A new ContextAwareCompletableFuture that is completed when all of the given CompletableFutures complete

Throws:

java.lang.NullPointerException - if the array or any of its elements are null

Since:

1.0.5

anyOf

public static ContextAwareCompletableFuture<java.lang.Object> anyOf(java.util.concurrent.CompletableFuture<?>... cfs)

Returns a new CompletableFuture that is completed when any of the given CompletableFutures complete, with the same result. Otherwise, if it completed exceptionally, the returned CompletableFuture also does so, with a CompletionException holding this exception as its cause. If no CompletableFutures are provided, returns an incomplete CompletableFuture.

A new ContextSnapshot is taken and applied to all following completion stages.

Parameters:

cfs - the CompletableFutures

Returns:

a new CompletableFuture that is completed with the result or exception of any of the given CompletableFutures when one completes

Throws:

java.lang.NullPointerException - if the array or any of its elements are null

Since:

1.0.5

anyOf

public static ContextAwareCompletableFuture<java.lang.Object> anyOf(ContextSnapshot snapshot,
                                                                    java.util.concurrent.CompletableFuture<?>... cfs)

Returns a new CompletableFuture that is completed when any of the given CompletableFutures complete, with the same result. Otherwise, if it completed exceptionally, the returned CompletableFuture also does so, with a CompletionException holding this exception as its cause. If no CompletableFutures are provided, returns an incomplete CompletableFuture.

The specified ContextSnapshot is applied to all following completion stages.

Parameters:

snapshot - the context snapshot to apply to following completion stages (optional, specify null to take a new snapshot)

cfs - the CompletableFutures

Returns:

a new CompletableFuture that is completed with the result or exception of any of the given CompletableFutures when one completes

Throws:

java.lang.NullPointerException - if the array or any of its elements are null

Since:

1.0.5

takeNewSnapshot

public ContextAwareCompletableFuture<T> takeNewSnapshot()

Returns a context-aware CompletableFuture that takes a new snapshot after each completion stage.

This means that after each then..., run..., apply... method, after calling the function, a new context snapshot is taken for follow-up calls.

Only use this when chaining completable futures where the completion stages may update contextual values.
Warning: This may result in unnecessary context snapshots being taken.

Returns:

A new context-aware completable future where context changes also propagate accross completion stages.

See Also:

CompletionStage

takeNewSnapshot

public ContextAwareCompletableFuture<T> takeNewSnapshot(boolean takeSnapshot)

Returns a context-aware CompletableFuture that may take a new snapshot after each completion stage.

This means that after each then..., run..., apply... method, after calling the function, a new context snapshot is taken for follow-up calls.

Only set this to true when chaining completable futures where the completion stages may update contextual values.
Warning: This may result in unnecessary context snapshots being taken.

Parameters:

takeSnapshot - whether or not new context snapshots must be taken after each completion stage.

Returns:

A context-aware completable future where context changes also propagate accross completion stages if takeSnapshot is true.

See Also:

CompletionStage

thenApply

public <U> ContextAwareCompletableFuture<U> thenApply(java.util.function.Function<? super T,? extends U> fn)

Overrides:

thenApply in class java.util.concurrent.CompletableFuture<T>

thenApplyAsync

public <U> ContextAwareCompletableFuture<U> thenApplyAsync(java.util.function.Function<? super T,? extends U> fn)

Overrides:

thenApplyAsync in class java.util.concurrent.CompletableFuture<T>

thenApplyAsync

public <U> ContextAwareCompletableFuture<U> thenApplyAsync(java.util.function.Function<? super T,? extends U> fn,
                                                           java.util.concurrent.Executor executor)

Overrides:

thenApplyAsync in class java.util.concurrent.CompletableFuture<T>

thenAccept

public ContextAwareCompletableFuture<java.lang.Void> thenAccept(java.util.function.Consumer<? super T> action)

Overrides:

thenAccept in class java.util.concurrent.CompletableFuture<T>

thenAcceptAsync

public ContextAwareCompletableFuture<java.lang.Void> thenAcceptAsync(java.util.function.Consumer<? super T> action)

Overrides:

thenAcceptAsync in class java.util.concurrent.CompletableFuture<T>

thenAcceptAsync

public ContextAwareCompletableFuture<java.lang.Void> thenAcceptAsync(java.util.function.Consumer<? super T> action,
                                                                     java.util.concurrent.Executor executor)

Overrides:

thenAcceptAsync in class java.util.concurrent.CompletableFuture<T>

thenRun

public ContextAwareCompletableFuture<java.lang.Void> thenRun(java.lang.Runnable action)

Overrides:

thenRun in class java.util.concurrent.CompletableFuture<T>

thenRunAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> thenRunAsync(java.lang.Runnable action)

Overrides:

thenRunAsync in class java.util.concurrent.CompletableFuture<T>

thenRunAsync

public ContextAwareCompletableFuture<java.lang.Void> thenRunAsync(java.lang.Runnable action,
                                                                  java.util.concurrent.Executor executor)

Overrides:

thenRunAsync in class java.util.concurrent.CompletableFuture<T>

thenCombine

public <U,V> ContextAwareCompletableFuture<V> thenCombine(java.util.concurrent.CompletionStage<? extends U> other,
                                                          java.util.function.BiFunction<? super T,? super U,? extends V> fn)

Overrides:

thenCombine in class java.util.concurrent.CompletableFuture<T>

thenCombineAsync

public <U,V> ContextAwareCompletableFuture<V> thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                                               java.util.function.BiFunction<? super T,? super U,? extends V> fn)

Overrides:

thenCombineAsync in class java.util.concurrent.CompletableFuture<T>

thenCombineAsync

public <U,V> ContextAwareCompletableFuture<V> thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                                               java.util.function.BiFunction<? super T,? super U,? extends V> fn,
                                                               java.util.concurrent.Executor executor)

Overrides:

thenCombineAsync in class java.util.concurrent.CompletableFuture<T>

thenAcceptBoth

public <U> ContextAwareCompletableFuture<java.lang.Void> thenAcceptBoth(java.util.concurrent.CompletionStage<? extends U> other,
                                                                        java.util.function.BiConsumer<? super T,? super U> action)

Overrides:

thenAcceptBoth in class java.util.concurrent.CompletableFuture<T>

thenAcceptBothAsync

public <U> ContextAwareCompletableFuture<java.lang.Void> thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                                                             java.util.function.BiConsumer<? super T,? super U> action)

Overrides:

thenAcceptBothAsync in class java.util.concurrent.CompletableFuture<T>

thenAcceptBothAsync

public <U> ContextAwareCompletableFuture<java.lang.Void> thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                                                             java.util.function.BiConsumer<? super T,? super U> action,
                                                                             java.util.concurrent.Executor executor)

Overrides:

thenAcceptBothAsync in class java.util.concurrent.CompletableFuture<T>

runAfterBoth

public ContextAwareCompletableFuture<java.lang.Void> runAfterBoth(java.util.concurrent.CompletionStage<?> other,
                                                                  java.lang.Runnable action)

Overrides:

runAfterBoth in class java.util.concurrent.CompletableFuture<T>

runAfterBothAsync

public ContextAwareCompletableFuture<java.lang.Void> runAfterBothAsync(java.util.concurrent.CompletionStage<?> other,
                                                                       java.lang.Runnable action)

Overrides:

runAfterBothAsync in class java.util.concurrent.CompletableFuture<T>

runAfterBothAsync

public ContextAwareCompletableFuture<java.lang.Void> runAfterBothAsync(java.util.concurrent.CompletionStage<?> other,
                                                                       java.lang.Runnable action,
                                                                       java.util.concurrent.Executor executor)

Overrides:

runAfterBothAsync in class java.util.concurrent.CompletableFuture<T>

applyToEither

public <U> ContextAwareCompletableFuture<U> applyToEither(java.util.concurrent.CompletionStage<? extends T> other,
                                                          java.util.function.Function<? super T,U> fn)

Overrides:

applyToEither in class java.util.concurrent.CompletableFuture<T>

applyToEitherAsync

public <U> ContextAwareCompletableFuture<U> applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                                               java.util.function.Function<? super T,U> fn)

Overrides:

applyToEitherAsync in class java.util.concurrent.CompletableFuture<T>

applyToEitherAsync

public <U> ContextAwareCompletableFuture<U> applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                                               java.util.function.Function<? super T,U> fn,
                                                               java.util.concurrent.Executor executor)

Overrides:

applyToEitherAsync in class java.util.concurrent.CompletableFuture<T>

acceptEither

public ContextAwareCompletableFuture<java.lang.Void> acceptEither(java.util.concurrent.CompletionStage<? extends T> other,
                                                                  java.util.function.Consumer<? super T> action)

Overrides:

acceptEither in class java.util.concurrent.CompletableFuture<T>

acceptEitherAsync

public ContextAwareCompletableFuture<java.lang.Void> acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                                                       java.util.function.Consumer<? super T> action)

Overrides:

acceptEitherAsync in class java.util.concurrent.CompletableFuture<T>

acceptEitherAsync

public ContextAwareCompletableFuture<java.lang.Void> acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                                                       java.util.function.Consumer<? super T> action,
                                                                       java.util.concurrent.Executor executor)

Overrides:

acceptEitherAsync in class java.util.concurrent.CompletableFuture<T>

runAfterEither

public ContextAwareCompletableFuture<java.lang.Void> runAfterEither(java.util.concurrent.CompletionStage<?> other,
                                                                    java.lang.Runnable action)

Overrides:

runAfterEither in class java.util.concurrent.CompletableFuture<T>

runAfterEitherAsync

public ContextAwareCompletableFuture<java.lang.Void> runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other,
                                                                         java.lang.Runnable action)

Overrides:

runAfterEitherAsync in class java.util.concurrent.CompletableFuture<T>

runAfterEitherAsync

public ContextAwareCompletableFuture<java.lang.Void> runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other,
                                                                         java.lang.Runnable action,
                                                                         java.util.concurrent.Executor executor)

Overrides:

runAfterEitherAsync in class java.util.concurrent.CompletableFuture<T>

thenCompose

public <U> ContextAwareCompletableFuture<U> thenCompose(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)

Overrides:

thenCompose in class java.util.concurrent.CompletableFuture<T>

thenComposeAsync

public <U> ContextAwareCompletableFuture<U> thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)

Overrides:

thenComposeAsync in class java.util.concurrent.CompletableFuture<T>

thenComposeAsync

public <U> ContextAwareCompletableFuture<U> thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn,
                                                             java.util.concurrent.Executor executor)

Overrides:

thenComposeAsync in class java.util.concurrent.CompletableFuture<T>

whenComplete

public ContextAwareCompletableFuture<T> whenComplete(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)

Overrides:

whenComplete in class java.util.concurrent.CompletableFuture<T>

whenCompleteAsync

public ContextAwareCompletableFuture<T> whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)

Overrides:

whenCompleteAsync in class java.util.concurrent.CompletableFuture<T>

whenCompleteAsync

public ContextAwareCompletableFuture<T> whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action,
                                                          java.util.concurrent.Executor executor)

Overrides:

whenCompleteAsync in class java.util.concurrent.CompletableFuture<T>

handle

public <U> ContextAwareCompletableFuture<U> handle(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)

Overrides:

handle in class java.util.concurrent.CompletableFuture<T>

handleAsync

public <U> ContextAwareCompletableFuture<U> handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)

Overrides:

handleAsync in class java.util.concurrent.CompletableFuture<T>

handleAsync

public <U> ContextAwareCompletableFuture<U> handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn,
                                                        java.util.concurrent.Executor executor)

Overrides:

handleAsync in class java.util.concurrent.CompletableFuture<T>

exceptionally

public ContextAwareCompletableFuture<T> exceptionally(java.util.function.Function<java.lang.Throwable,? extends T> fn)

Overrides:

exceptionally in class java.util.concurrent.CompletableFuture<T>