Package io.foldright.cffu

Class Cffu<T>

java.lang.Object

io.foldright.cffu.Cffu<T>

All Implemented Interfaces:

CompletionStage<T>, Future<T>

@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
public final class Cffu<T>
extends Object
implements Future<T>, CompletionStage<T>

This class Cffu is the equivalent class to CompletableFuture, contains the equivalent instance methods of CompletionStage and CompletableFuture.

The methods that equivalent to static factory methods of CompletableFuture is in CffuFactory class.

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

• CffuFactoryBuilder
• CffuFactory
• CompletionStage
• CompletableFuture

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Method Summary

Modifier and Type	Method	Description
Cffu<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.
Cffu<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied action.
Cffu<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied action.
Cffu<Void>	acceptEitherSuccess(CompletionStage<? extends T> other, Consumer<? super T> action)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.
Cffu<Void>	acceptEitherSuccessAsync(CompletionStage<? extends T> other, Consumer<? super T> action)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied action.
Cffu<Void>	acceptEitherSuccessAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied action.
<T2> Cffu<Tuple2<T,T2>>	allTupleOf(CompletionStage<? extends T2> cf2)	This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2, T3> Cffu<Tuple3<T,T2,T3>>	allTupleOf(CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3)	This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2, T3, T4> Cffu<Tuple4<T,T2,T3,T4>>	allTupleOf(CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4)	This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2, T3, T4, T5> Cffu<Tuple5<T,T2,T3,T4,T5>>	allTupleOf(CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4, CompletionStage<? extends T5> cf5)	This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2> Cffu<Tuple2<T,T2>>	allTupleOfFastFail(CompletionStage<? extends T2> cf2)	This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2, T3> Cffu<Tuple3<T,T2,T3>>	allTupleOfFastFail(CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3)	This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2, T3, T4> Cffu<Tuple4<T,T2,T3,T4>>	allTupleOfFastFail(CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4)	This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<T2, T3, T4, T5> Cffu<Tuple5<T,T2,T3,T4,T5>>	allTupleOfFastFail(CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4, CompletionStage<? extends T5> cf5)	This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.
<U> Cffu<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.
<U> Cffu<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied function.
<U> Cffu<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied function.
<U> Cffu<U>	applyToEitherSuccess(CompletionStage<? extends T> other, Function<? super T,U> fn)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.
<U> Cffu<U>	applyToEitherSuccessAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied function.
<U> Cffu<U>	applyToEitherSuccessAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)	Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied function.
boolean	cancel(boolean mayInterruptIfRunning)	If not already completed, completes this Cffu with a CancellationException.
CffuFactory	cffuFactory()	Returns the CffuFactory of this Cffu.
CffuState	cffuState()	Returns the computation state(CffuState), this method is equivalent to CompletableFuture.state() with java version compatibility logic, so you can invoke in old java 18-.
CompletableFuture<T>	cffuUnwrap()	Returns the underlying CompletableFuture.
boolean	complete(T value)	If not already completed, sets the value returned by get() and related methods to the given value.
Cffu<T>	completeAsync(Supplier<? extends T> supplier)	Completes this Cffu with the result of the given Supplier function invoked from an asynchronous task using defaultExecutor().
Cffu<T>	completeAsync(Supplier<? extends T> supplier, Executor executor)	Completes this Cffu with the result of the given Supplier function invoked from an asynchronous task using the given executor.
boolean	completeExceptionally(Throwable ex)	If not already completed, causes invocations of get() and related methods to throw the given exception.
Cffu<T>	completeOnTimeout(T value, long timeout, TimeUnit unit)	Completes this Cffu with the given value if not otherwise completed before the given timeout.
Cffu<T>	copy()	Returns a new Cffu that is completed normally with the same value as this Cffu when it completes normally.
Executor	defaultExecutor()	Returns the default Executor used for async methods that do not specify an Executor.
Cffu<T>	exceptionally(Function<Throwable,? extends T> fn)	Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function.
Cffu<T>	exceptionallyAsync(Function<Throwable,? extends T> fn)	Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function, using defaultExecutor().
Cffu<T>	exceptionallyAsync(Function<Throwable,? extends T> fn, Executor executor)	Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function, using the supplied Executor.
Cffu<T>	exceptionallyCompose(Function<Throwable,? extends CompletionStage<T>> fn)	Returns a new CompletionStage that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception.
Cffu<T>	exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn)	Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception, using defaultExecutor().
Cffu<T>	exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn, Executor executor)	Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception, using the supplied Executor.
Throwable	exceptionNow()	Returns the exception thrown by the task, without waiting.
boolean	forbidObtrudeMethods()	Returns forbidObtrudeMethods or not.
T	get()	Waits if necessary for the computation to complete, and then retrieves its result.
T	get(long timeout, TimeUnit unit)	Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
T	getNow(T valueIfAbsent)	Returns the result value (or throws any encountered exception) if completed, else returns the given valueIfAbsent.
int	getNumberOfDependents()	Returns the estimated number of Cffus whose completions are awaiting completion of this Cffu.
<U> Cffu<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)	Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed with this cffu's result and exception as arguments to the supplied function.
<U> Cffu<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)	Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed using defaultExecutor(), with this cffu's result and exception as arguments to the supplied function.
<U> Cffu<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)	Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed using the supplied executor, with this cffu's result and exception as arguments to the supplied function.
boolean	isCancelled()	Returns true if this Cffu was cancelled before it completed normally.
boolean	isCompletedExceptionally()	Returns true if this Cffu completed exceptionally, in any way.
boolean	isDone()	Returns true if this task completed.
boolean	isMinimalStage()	Returns whether is a minimal stage or not.
T	join()	Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally.
T	join(long timeout, TimeUnit unit)	Waits if necessary for at most the given time for the computation to complete, and then retrieves its result value when complete, or throws an (unchecked) exception if completed exceptionally.
CompletionStage<T>	minimalCompletionStage()	Returns a new CompletionStage that is completed normally with the same value as this CompletableFuture when it completes normally, and cannot be independently completed or otherwise used in ways not defined by the methods of interface CompletionStage.
<U> Cffu<U>	newIncompleteFuture()	Returns a new incomplete Cffu with CompletableFuture of the type to be returned by a CompletionStage method.
void	obtrudeException(Throwable ex)	Forcibly causes subsequent invocations of method get() and related methods to throw the given exception, whether or not already completed.
void	obtrudeValue(T value)	Forcibly sets or resets the value subsequently returned by method get() and related methods, whether or not already completed.
Cffu<T>	orTimeout(long timeout, TimeUnit unit)	Exceptionally completes this Cffu with a TimeoutException if not otherwise completed before the given timeout.
Cffu<T>	peek(BiConsumer<? super T,? super Throwable> action)	Peeks the result by executing the given action when this cffu completes, returns this cffu.
Cffu<T>	peekAsync(BiConsumer<? super T,? super Throwable> action)	Peeks the result by executing the given action when this cffu completes, executes the given action using defaultExecutor(), returns this cffu.
Cffu<T>	peekAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)	Peeks the result by executing the given action when this cffu completes, that executes the given action using the supplied Executor when this cffu completes, returns this cffu.
Cffu<T>	resetCffuFactory(CffuFactory cffuFactory)	Returns a new Cffu with given CffuFactory(contained configuration) that is completed normally with the same value as this Cffu when it completes normally.
T	resultNow()	Returns the computed result, without waiting.
Cffu<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action.
Cffu<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using defaultExecutor().
Cffu<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)	Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using the supplied executor.
Cffu<Void>	runAfterBothFastFail(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action.
Cffu<Void>	runAfterBothFastFailAsync(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using defaultExecutor().
Cffu<Void>	runAfterBothFastFailAsync(CompletionStage<?> other, Runnable action, Executor executor)	Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using the supplied executor.
Cffu<Void>	runAfterEither(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action.
Cffu<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using defaultExecutor().
Cffu<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)	Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using the supplied executor.
Cffu<Void>	runAfterEitherSuccess(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action.
Cffu<Void>	runAfterEitherSuccessAsync(CompletionStage<?> other, Runnable action)	Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using defaultExecutor().
Cffu<Void>	runAfterEitherSuccessAsync(CompletionStage<?> other, Runnable action, Executor executor)	Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using the supplied executor.
Future.State	state()	Returns the computation state, this method contains NO java version compatibility logic, if you need this function in old java 18-, use cffuState() instead.
Cffu<Void>	thenAccept(Consumer<? super T> action)	Returns a new Cffu that, when this stage completes normally, is executed with this stage's result as the argument to the supplied action.
Cffu<Void>	thenAcceptAsync(Consumer<? super T> action)	Returns a new Cffu that, when this stage completes normally, is executed using defaultExecutor(), with this stage's result as the argument to the supplied action.
Cffu<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)	Returns a new Cffu that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied action.
<U> Cffu<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action.
<U> Cffu<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied action.
<U> Cffu<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied action.
<U> Cffu<Void>	thenAcceptBothFastFail(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action.
<U> Cffu<Void>	thenAcceptBothFastFailAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied action.
<U> Cffu<Void>	thenAcceptBothFastFailAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied action.
<U> Cffu<U>	thenApply(Function<? super T,? extends U> fn)	Returns a new Cffu that, when this stage completes normally, is executed with this stage's result as the argument to the supplied function.
<U> Cffu<U>	thenApplyAsync(Function<? super T,? extends U> fn)	Returns a new Cffu that, when this stage completes normally, is executed using defaultExecutor(), with this stage's result as the argument to the supplied function.
<U> Cffu<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)	Returns a new Cffu that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied function.
<U, V> Cffu<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function.
<U, V> Cffu<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied function.
<U, V> Cffu<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied function.
<U, V> Cffu<V>	thenCombineFastFail(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function.
<U, V> Cffu<V>	thenCombineFastFailAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied function.
<U, V> Cffu<V>	thenCombineFastFailAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)	Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied function.
<U> Cffu<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)	Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function.
<U> Cffu<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)	Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function, executed using defaultExecutor().
<U> Cffu<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)	Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function, executed using the supplied Executor.
Cffu<Void>	thenRun(Runnable action)	Returns a new Cffu that, when this stage completes normally, executes the given action.
Cffu<Void>	thenRunAsync(Runnable action)	Returns a new Cffu that, when this stage completes normally, executes the given action using defaultExecutor().
Cffu<Void>	thenRunAsync(Runnable action, Executor executor)	Returns a new Cffu that, when this stage completes normally, executes the given action using the supplied Executor.
CompletableFuture<T>	toCompletableFuture()	Returns a CompletableFuture maintaining the same completion properties as this stage.
String	toString()	Returns a string identifying this Cffu, as well as its completion state.
Cffu<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)	Returns a new Cffu with the same result or exception as this stage, that executes the given action when this stage completes.
Cffu<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)	Returns a new Cffu with the same result or exception as this stage, that executes the given action using defaultExecutor() when this stage completes.
Cffu<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)	Returns a new Cffu with the same result or exception as this stage, that executes the given action using the supplied Executor when this stage completes.

Methods inherited from class java.lang.Object

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

Method Details

thenRun

public Cffu<Void> thenRun(Runnable action)

Returns a new Cffu that, when this stage completes normally, executes the given action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenRun in interface CompletionStage<T>

Parameters:

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenRun(Runnable)

thenRunAsync

public Cffu<Void> thenRunAsync(Runnable action)

Returns a new Cffu that, when this stage completes normally, executes the given action using defaultExecutor().

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenRunAsync in interface CompletionStage<T>

Parameters:

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenRunAsync(Runnable)

thenRunAsync

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

Returns a new Cffu that, when this stage completes normally, executes the given action using the supplied Executor.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenRunAsync in interface CompletionStage<T>

Parameters:

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenRunAsync(Runnable, Executor)

thenAccept

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

Returns a new Cffu that, when this stage completes normally, is executed with this stage's result as the argument to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenAccept in interface CompletionStage<T>

Parameters:

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenAccept(Consumer)

thenAcceptAsync

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

Returns a new Cffu that, when this stage completes normally, is executed using defaultExecutor(), with this stage's result as the argument to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Parameters:

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenAcceptAsync(Consumer)

thenAcceptAsync

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

Returns a new Cffu that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Parameters:

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

See Also:

• CompletionStage.thenAcceptAsync(Consumer, Executor)

thenApply

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenRun`")
public <U> Cffu<U> thenApply(Function<? super T,? extends U> fn)

Returns a new Cffu that, when this stage completes normally, is executed with this stage's result as the argument to the supplied function.

This method is analogous to Optional.map and Stream.map.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenApply in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenApply(Function)

thenApplyAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenRunAsync`")
public <U> Cffu<U> thenApplyAsync(Function<? super T,? extends U> fn)

Returns a new Cffu that, when this stage completes normally, is executed using defaultExecutor(), with this stage's result as the argument to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenApplyAsync in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

See Also:

• CompletionStage.thenApplyAsync(Function)

thenApplyAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenRunAsync`")
public <U> Cffu<U> thenApplyAsync(Function<? super T,? extends U> fn,
 Executor executor)

Returns a new Cffu that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenApplyAsync in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

fn - the function to use to compute the value of the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

See Also:

• CompletionStage.thenApplyAsync(Function, Executor)

runAfterBoth

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

Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

runAfterBoth in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterBothAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using defaultExecutor().

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterBothAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using the supplied executor.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

runAfterBothFastFail

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

Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as runAfterBoth(CompletionStage, Runnable) except for the fast-fail behavior.

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterBothFastFailAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using defaultExecutor(). if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as runAfterBothAsync(CompletionStage, Runnable) except for the fast-fail behavior.

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterBothFastFailAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using the supplied executor. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as runAfterBothAsync(CompletionStage, Runnable, Executor) except for the fast-fail behavior.

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

thenAcceptBoth

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

Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenAcceptBoth in interface CompletionStage<T>

Type Parameters:

U - the type of the other CompletionStage's result

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

thenAcceptBothAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Type Parameters:

U - the type of the other CompletionStage's result

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

thenAcceptBothAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Type Parameters:

U - the type of the other CompletionStage's result

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

thenAcceptBothFastFail

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

Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as thenAcceptBoth(CompletionStage, BiConsumer) except for the fast-fail behavior.

Type Parameters:

U - the type of the other CompletionStage's result

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

thenAcceptBothFastFailAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as thenAcceptBothAsync(CompletionStage, BiConsumer) except for the fast-fail behavior.

Type Parameters:

U - the type of the other CompletionStage's result

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

thenAcceptBothFastFailAsync

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

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as thenAcceptBothAsync(CompletionStage, BiConsumer, Executor) except for the fast-fail behavior.

Type Parameters:

U - the type of the other CompletionStage's result

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

thenCombine

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBoth`")
public <U,
V> Cffu<V> thenCombine(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn)

Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenCombine in interface CompletionStage<T>

Type Parameters:

U - the type of the other CompletionStage's result

V - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

thenCombineAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothAsync`")
public <U,
V> Cffu<V> thenCombineAsync(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn)

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenCombineAsync in interface CompletionStage<T>

Type Parameters:

U - the type of the other CompletionStage's result

V - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

thenCombineAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothAsync`")
public <U,
V> Cffu<V> thenCombineAsync(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn,
 Executor executor)

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenCombineAsync in interface CompletionStage<T>

Type Parameters:

U - the type of the other CompletionStage's result

V - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

thenCombineFastFail

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothFastFail`")
public <U,
V> Cffu<V> thenCombineFastFail(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn)

Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as thenCombine(CompletionStage, BiFunction) except for the fast-fail behavior.

Type Parameters:

U - the type of the other CompletionStage's result

V - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

thenCombineFastFailAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothFastFailAsync`")
public <U,
V> Cffu<V> thenCombineFastFailAsync(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn)

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied function. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as thenCombineAsync(CompletionStage, BiFunction) except for the fast-fail behavior.

Type Parameters:

U - the type of the other CompletionStage's result

V - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

thenCombineFastFailAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothFastFailAsync`")
public <U,
V> Cffu<V> thenCombineFastFailAsync(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn,
 Executor executor)

Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied function. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.

This method is the same as thenCombineAsync(CompletionStage, BiFunction, Executor) except for the fast-fail behavior.

Type Parameters:

U - the type of the other CompletionStage's result

V - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

allTupleOf

@Contract(pure=true)
public <T2> Cffu<Tuple2<T,T2>> allTupleOf(CompletionStage<? extends T2> cf2)

This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOf(cf2);

is the same as:

allTuple = cffu.cffuFactory().allTupleOf(cffu, cf2);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOf(CompletionStage, CompletionStage)

allTupleOfFastFail

@Contract(pure=true)
public <T2> Cffu<Tuple2<T,T2>> allTupleOfFastFail(CompletionStage<? extends T2> cf2)

This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOfFastFail(cf2);

is the same as:

allTuple = cffu.cffuFactory().allTupleOfFastFail(cffu, cf2);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage)

allTupleOf

@Contract(pure=true)
public <T2,
T3> Cffu<Tuple3<T,T2,T3>> allTupleOf(CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3)

This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOf(cf2, cf3);

is the same as:

allTuple = cffu.cffuFactory().allTupleOf(cffu, cf2, cf3);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage)

allTupleOfFastFail

@Contract(pure=true)
public <T2,
T3> Cffu<Tuple3<T,T2,T3>> allTupleOfFastFail(CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3)

This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOfFastFail(cf2, cf3);

is the same as:

allTuple = cffu.cffuFactory().allTupleOfFastFail(cffu, cf2, cf3);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage)

allTupleOf

@Contract(pure=true)
public <T2,
T3,
T4> Cffu<Tuple4<T,T2,T3,T4>> allTupleOf(CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3,
 CompletionStage<? extends T4> cf4)

This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOf(cf2, cf3, cf4);

is the same as:

allTuple = cffu.cffuFactory().allTupleOf(cffu, cf2, cf3, cf4);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage, CompletionStage)

allTupleOfFastFail

@Contract(pure=true)
public <T2,
T3,
T4> Cffu<Tuple4<T,T2,T3,T4>> allTupleOfFastFail(CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3,
 CompletionStage<? extends T4> cf4)

This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOfFastFail(cf2, cf3, cf4);

is the same as:

allTuple = cffu.cffuFactory().allTupleOfFastFail(cffu, cf2, cf3, cf4);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage, CompletionStage)

allTupleOf

@Contract(pure=true)
public <T2,
T3,
T4,
T5> Cffu<Tuple5<T,T2,T3,T4,T5>> allTupleOf(CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3,
 CompletionStage<? extends T4> cf4,
 CompletionStage<? extends T5> cf5)

This method is the same as CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOf(cf2, cf3, cf4, cf5);

is the same as:

allTuple = cffu.cffuFactory().allTupleOf(cffu, cf2, cf3, cf4, cf5);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOf(CompletionStage, CompletionStage, CompletionStage, CompletionStage, CompletionStage)

allTupleOfFastFail

@Contract(pure=true)
public <T2,
T3,
T4,
T5> Cffu<Tuple5<T,T2,T3,T4,T5>> allTupleOfFastFail(CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3,
 CompletionStage<? extends T4> cf4,
 CompletionStage<? extends T5> cf5)

This method is the same as CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage, CompletionStage, CompletionStage), providing this method is convenient for method chaining.

Calling this method

allTuple = cffu.allTupleOfFastFail(cf2, cf3, cf4, cf5);

is the same as:

allTuple = cffu.cffuFactory().allTupleOfFastFail(cffu, cf2, cf3, cf4, cf5);

Returns:

the new Cffu

See Also:

• CffuFactory.allTupleOfFastFail(CompletionStage, CompletionStage, CompletionStage, CompletionStage, CompletionStage)

runAfterEither

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

Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

runAfterEither in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterEitherAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using defaultExecutor().

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterEitherAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using the supplied executor.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

runAfterEitherSuccess

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

Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action. Otherwise, all two complete exceptionally, the returned CompletableFuture also does so, with a CompletionException holding an exception from any of as its cause.

This method is the same as runAfterEither(CompletionStage, Runnable) except for the either-success behavior(not either-complete).

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterEitherSuccessAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using defaultExecutor().

See the CompletionStage documentation for rules covering exceptional completion.

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

runAfterEitherSuccessAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using the supplied executor.

See the CompletionStage documentation for rules covering exceptional completion.

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

acceptEither

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

Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

acceptEither in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

acceptEitherAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

acceptEitherAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied action.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

acceptEitherSuccess

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

Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.

This method is the same as acceptEither(CompletionStage, Consumer) except for the either-success behavior(not either-complete).

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

acceptEitherSuccessAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied action.

This method is the same as acceptEitherAsync(CompletionStage, Consumer) except for the either-success behavior(not either-complete).

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

Returns:

the new Cffu

acceptEitherSuccessAsync

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

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied action.

This method is the same as acceptEitherAsync(CompletionStage, Consumer, Executor) except for the either-success behavior(not either-complete).

Parameters:

other - the other CompletionStage

action - the action to perform before completing the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

applyToEither

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEither`")
public <U> Cffu<U> applyToEither(CompletionStage<? extends T> other,
 Function<? super T,U> fn)

Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

applyToEither in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

applyToEitherAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherAsync`")
public <U> Cffu<U> applyToEitherAsync(CompletionStage<? extends T> other,
 Function<? super T,U> fn)

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

applyToEitherAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherAsync`")
public <U> Cffu<U> applyToEitherAsync(CompletionStage<? extends T> other,
 Function<? super T,U> fn,
 Executor executor)

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied function.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

applyToEitherSuccess

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherSuccess`")
public <U> Cffu<U> applyToEitherSuccess(CompletionStage<? extends T> other,
 Function<? super T,U> fn)

Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.

This method is the same as applyToEither(CompletionStage, Function) except for the either-success behavior(not either-complete).

Type Parameters:

U - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

applyToEitherSuccessAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherSuccessAsync`")
public <U> Cffu<U> applyToEitherSuccessAsync(CompletionStage<? extends T> other,
 Function<? super T,U> fn)

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied function.

This method is the same as applyToEitherAsync(CompletionStage, Function) except for the either-success behavior(not either-complete).

Type Parameters:

U - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

applyToEitherSuccessAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherSuccessAsync`")
public <U> Cffu<U> applyToEitherSuccessAsync(CompletionStage<? extends T> other,
 Function<? super T,U> fn,
 Executor executor)

Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied function.

This method is the same as applyToEitherAsync(CompletionStage, Function, Executor) except for the either-success behavior(not either-complete).

Type Parameters:

U - the function's return type

Parameters:

other - the other CompletionStage

fn - the function to use to compute the value of the returned Cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

exceptionally

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

Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function. Otherwise, if this stage completes normally, then the returned stage also completes normally with the same value.

Specified by:

exceptionally in interface CompletionStage<T>

Parameters:

fn - the function to use to compute the value of the returned Cffu if this Cffu completed exceptionally

Returns:

the new Cffu

exceptionallyAsync

public Cffu<T> exceptionallyAsync(Function<Throwable,? extends T> fn)

Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function, using defaultExecutor(). Otherwise, if this stage completes normally, then the returned stage also completes normally with the same value.

Specified by:

exceptionallyAsync in interface CompletionStage<T>

Parameters:

fn - the function to use to compute the value of the returned Cffu if this Cffu completed exceptionally

Returns:

the new Cffu

exceptionallyAsync

public Cffu<T> exceptionallyAsync(Function<Throwable,? extends T> fn,
 Executor executor)

Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function, using the supplied Executor. Otherwise, if this stage completes normally, then the returned stage also completes normally with the same value.

Specified by:

exceptionallyAsync in interface CompletionStage<T>

Parameters:

fn - the function to use to compute the value of the returned Cffu if this Cffu completed exceptionally

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

orTimeout

public Cffu<T> orTimeout(long timeout,
 TimeUnit unit)

Exceptionally completes this Cffu with a TimeoutException if not otherwise completed before the given timeout.

Parameters:

timeout - how long to wait before completing exceptionally with a TimeoutException, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

this Cffu

See Also:

• CffuFactory.delayedExecutor(long, TimeUnit)

completeOnTimeout

public Cffu<T> completeOnTimeout(@Nullable
 T value,
 long timeout,
 TimeUnit unit)

Completes this Cffu with the given value if not otherwise completed before the given timeout.

Parameters:

value - the value to use upon timeout

timeout - how long to wait before completing normally with the given value, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

this Cffu

See Also:

• CffuFactory.delayedExecutor(long, TimeUnit)

thenCompose

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

Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function.

When this stage completes normally, the given function is invoked with this stage's result as the argument, returning another CompletionStage. When that stage completes normally, the Cffu returned by this method is completed with the same value.

To ensure progress, the supplied function must arrange eventual completion of its result.

This method is analogous to Optional.flatMap and Stream.flatMap.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenCompose in interface CompletionStage<T>

Type Parameters:

U - the type of the returned Cffu's result

Parameters:

fn - the function to use to compute another CompletionStage

Returns:

the new Cffu

thenComposeAsync

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

Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function, executed using defaultExecutor().

When this stage completes normally, the given function is invoked with this stage's result as the argument, returning another CompletionStage. When that stage completes normally, the Cffu returned by this method is completed with the same value.

To ensure progress, the supplied function must arrange eventual completion of its result.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenComposeAsync in interface CompletionStage<T>

Type Parameters:

U - the type of the returned Cffu's result

Parameters:

fn - the function to use to compute another CompletionStage

Returns:

the new Cffu

thenComposeAsync

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

Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function, executed using the supplied Executor.

When this stage completes normally, the given function is invoked with this stage's result as the argument, returning another CompletionStage. When that stage completes normally, the Cffu returned by this method is completed with the same value.

To ensure progress, the supplied function must arrange eventual completion of its result.

See the CompletionStage documentation for rules covering exceptional completion.

Specified by:

thenComposeAsync in interface CompletionStage<T>

Type Parameters:

U - the type of the returned Cffu's result

Parameters:

fn - the function to use to compute another CompletionStage

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

exceptionallyCompose

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

Returns a new CompletionStage that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception.

Specified by:

exceptionallyCompose in interface CompletionStage<T>

Parameters:

fn - the function to use to compute the returned CompletionStage if this CompletionStage completed exceptionally

Returns:

the new CompletionStage

exceptionallyComposeAsync

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

Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception, using defaultExecutor().

Specified by:

exceptionallyComposeAsync in interface CompletionStage<T>

Parameters:

fn - the function to use to compute the returned CompletionStage if this Cffu completed exceptionally

Returns:

the new Cffu

exceptionallyComposeAsync

public Cffu<T> exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn,
 Executor executor)

Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception, using the supplied Executor.

Specified by:

exceptionallyComposeAsync in interface CompletionStage<T>

Parameters:

fn - the function to use to compute the returned CompletionStage if this Cffu completed exceptionally

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

handle

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `whenComplete`")
public <U> Cffu<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed with this cffu's result and exception as arguments to the supplied function.

When this cffu is complete, the given function is invoked with the result (or null if none) and the exception (or null if none) of this cffu as arguments, and the function's result is used to complete the returned cffu.

Specified by:

handle in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

handleAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `whenCompleteAsync`")
public <U> Cffu<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed using defaultExecutor(), with this cffu's result and exception as arguments to the supplied function.

When this Cffu is complete, the given function is invoked with the result (or null if none) and the exception (or null if none) of this Cffu as arguments, and the function's result is used to complete the returned Cffu.

Specified by:

handleAsync in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

fn - the function to use to compute the value of the returned Cffu

Returns:

the new Cffu

handleAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `whenCompleteAsync`")
public <U> Cffu<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
 Executor executor)

Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed using the supplied executor, with this cffu's result and exception as arguments to the supplied function.

When this cffu is complete, the given function is invoked with the result (or null if none) and the exception (or null if none) of this cffu as arguments, and the function's result is used to complete the returned cffu.

Specified by:

handleAsync in interface CompletionStage<T>

Type Parameters:

U - the function's return type

Parameters:

fn - the function to use to compute the value of the returned cffu

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

whenComplete

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

Returns a new Cffu with the same result or exception as this stage, that executes the given action when this stage completes.

When this stage is complete, the given action is invoked with the result (or null if none) and the exception (or null if none) of this stage as arguments. The returned stage is completed when the action returns.

Unlike method handle, this method is not designed to translate completion outcomes, so the supplied action should not throw an exception. However, if it does, the following rules apply: if this stage completed normally but the supplied action throws an exception, then the returned stage completes exceptionally with the supplied action's exception. Or, if this stage completed exceptionally and the supplied action throws an exception, then the returned stage completes exceptionally with this stage's exception.

Specified by:

whenComplete in interface CompletionStage<T>

Parameters:

action - the action to perform

Returns:

the new Cffu

whenCompleteAsync

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

Returns a new Cffu with the same result or exception as this stage, that executes the given action using defaultExecutor() when this stage completes.

When this stage is complete, the given action is invoked with the result (or null if none) and the exception (or null if none) of this stage as arguments. The returned stage is completed when the action returns.

Unlike method handleAsync, this method is not designed to translate completion outcomes, so the supplied action should not throw an exception. However, if it does, the following rules apply: If this stage completed normally but the supplied action throws an exception, then the returned stage completes exceptionally with the supplied action's exception. Or, if this stage completed exceptionally and the supplied action throws an exception, then the returned stage completes exceptionally with this stage's exception.

Specified by:

whenCompleteAsync in interface CompletionStage<T>

Parameters:

action - the action to perform

Returns:

the new Cffu

whenCompleteAsync

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

Returns a new Cffu with the same result or exception as this stage, that executes the given action using the supplied Executor when this stage completes.

When this stage is complete, the given action is invoked with the result (or null if none) and the exception (or null if none) of this stage as arguments. The returned stage is completed when the action returns.

Unlike method handleAsync, this method is not designed to translate completion outcomes, so the supplied action should not throw an exception. However, if it does, the following rules apply: If this stage completed normally but the supplied action throws an exception, then the returned stage completes exceptionally with the supplied action's exception. Or, if this stage completed exceptionally and the supplied action throws an exception, then the returned stage completes exceptionally with this stage's exception.

Specified by:

whenCompleteAsync in interface CompletionStage<T>

Parameters:

action - the action to perform

executor - the executor to use for asynchronous execution

Returns:

the new Cffu

peek

public Cffu<T> peek(BiConsumer<? super T,? super Throwable> action)

Peeks the result by executing the given action when this cffu completes, returns this cffu.

When this cffu is complete, the given action is invoked with the result (or null if none) and the exception (or null if none) of this cffu as arguments. Whether the supplied action throws an exception or not, do NOT affect this cffu.

Unlike method handle and like method whenComplete, this method is not designed to translate completion outcomes.

Parameters:

action - the action to perform

Returns:

this Cffu

See Also:

• CompletionStage.whenComplete(BiConsumer)
• Stream.peek(Consumer)

peekAsync

public Cffu<T> peekAsync(BiConsumer<? super T,? super Throwable> action)

Peeks the result by executing the given action when this cffu completes, executes the given action using defaultExecutor(), returns this cffu.

When this cffu is complete, the given action is invoked with the result (or null if none) and the exception (or null if none) of this cffu as arguments. Whether the supplied action throws an exception or not, do NOT affect this cffu.

Unlike method handle and like method whenComplete, this method is not designed to translate completion outcomes.

Parameters:

action - the action to perform

Returns:

this Cffu

See Also:

• CompletionStage.whenCompleteAsync(BiConsumer)
• Stream.peek(Consumer)

peekAsync

public Cffu<T> peekAsync(BiConsumer<? super T,? super Throwable> action,
 Executor executor)

Peeks the result by executing the given action when this cffu completes, that executes the given action using the supplied Executor when this cffu completes, returns this cffu.

When this cffu is complete, the given action is invoked with the result (or null if none) and the exception (or null if none) of this cffu as arguments. Whether the supplied action throws an exception or not, do NOT affect this cffu.

Unlike method handle and like method whenComplete, this method is not designed to translate completion outcomes.

Parameters:

action - the action to perform

Returns:

this Cffu

See Also:

• CompletionStage.whenCompleteAsync(BiConsumer)
• Stream.peek(Consumer)

get

@Blocking
@Nullable
public T get()
      throws InterruptedException,
ExecutionException

Waits if necessary for the computation to complete, and then retrieves its result.

Specified by:

get in interface Future<T>

Returns:

the computed result

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

See Also:

• join()
• join(long, TimeUnit)
• getNow(Object)
• resultNow()
• get(long, TimeUnit)

get

@Blocking
@Nullable
public T get(long timeout,
 TimeUnit unit)
      throws InterruptedException,
ExecutionException,
TimeoutException

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Specified by:

get in interface Future<T>

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the computed result

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

TimeoutException - if the wait timed out

See Also:

• join(long, TimeUnit)
• getNow(Object)
• resultNow()
• join()
• get()

join

@Blocking
@Nullable
public T join()

Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally.

To better conform with the use of common functional forms, if a computation involved in the completion of this Cffu threw an exception, this method throws an (unchecked) CompletionException with the underlying exception as its cause.

Returns:

the result value

Throws:

CancellationException - if the computation was cancelled

CompletionException - if this future completed exceptionally or a completion computation threw an exception

See Also:

• join(long, TimeUnit)
• getNow(Object)
• resultNow()
• get(long, TimeUnit)
• get()

join

@Blocking
@Nullable
public T join(long timeout,
 TimeUnit unit)

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result value when complete, or throws an (unchecked) exception if completed exceptionally.

NOTE:
Calling this method

result = cffu.join(timeout, unit);

is the same as:

result = cffu.copy() // defensive copy to avoid writing this cffu unexpectedly
     .orTimeout(timeout, unit)
     .join();
 

CAUTION:
if the wait timed out, this method throws an (unchecked) CompletionException with the TimeoutException as its cause; NOT throws a (checked) TimeoutException like get(long, TimeUnit).

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the result value

Throws:

CancellationException - if the computation was cancelled

CompletionException - if this future completed exceptionally or a completion computation threw an exception or the wait timed out(with the TimeoutException as its cause)

See Also:

• join()
• getNow(Object)
• resultNow()
• get(long, TimeUnit)
• get()
• orTimeout(long, TimeUnit)

getNow

@Contract(pure=true)
@Nullable
public T getNow(T valueIfAbsent)

Returns the result value (or throws any encountered exception) if completed, else returns the given valueIfAbsent.

Parameters:

valueIfAbsent - the value to return if not completed

Returns:

the result value, if completed, else the given valueIfAbsent

Throws:

CancellationException - if the computation was cancelled

CompletionException - if this future completed exceptionally or a completion computation threw an exception

See Also:

• resultNow()
• join(long, TimeUnit)
• join()
• get(long, TimeUnit)
• get()

resultNow

@Contract(pure=true)
@Nullable
public T resultNow()

Returns the computed result, without waiting.

This method is for cases where the caller knows that the task has already completed successfully, for example when filtering a stream of Future objects for the successful tasks and using a mapping operation to obtain a stream of results.

results = futures.stream()
     .filter(f -> f.state() == Future.State.SUCCESS)
     .map(Future::resultNow)
     .toList();
 

Specified by:

resultNow in interface Future<T>

See Also:

• getNow(Object)

exceptionNow

@Contract(pure=true)
public Throwable exceptionNow()

Returns the exception thrown by the task, without waiting.

This method is for cases where the caller knows that the task has already completed with an exception.

Specified by:

exceptionNow in interface Future<T>

Returns:

the exception thrown by the task

Throws:

IllegalStateException - if the task has not completed, the task completed normally, or the task was cancelled

See Also:

• resultNow()

isDone

@Contract(pure=true)
public boolean isDone()

Returns true if this task completed.

Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Specified by:

isDone in interface Future<T>

Returns:

true if this task completed

isCompletedExceptionally

@Contract(pure=true)
public boolean isCompletedExceptionally()

Returns true if this Cffu completed exceptionally, in any way. Possible causes include cancellation, explicit invocation of completeExceptionally, and abrupt termination of a CompletionStage action.

Returns:

true if this Cffu completed exceptionally

isCancelled

@Contract(pure=true)
public boolean isCancelled()

Returns true if this Cffu was cancelled before it completed normally.

Specified by:

isCancelled in interface Future<T>

Returns:

true if this Cffu was cancelled before it completed normally

state

@Contract(pure=true)
public Future.State state()

Returns the computation state, this method contains NO java version compatibility logic, if you need this function in old java 18-, use cffuState() instead.

NOTE:
CompletableFuture.state() is new method since Java 19, this method should have compatibility logic for old Java version; But the return type Future.State is also added since Java 19, so it's IMPOSSIBLE to backport by compatibility logic of wrapper class(Cffu).

Specified by:

state in interface Future<T>

Returns:

the computation state

See Also:

• cffuState()
• Future.State
• CompletableFuture.state()

cffuState

@Contract(pure=true)
public CffuState cffuState()

Returns the computation state(CffuState), this method is equivalent to CompletableFuture.state() with java version compatibility logic, so you can invoke in old java 18-.

Returns:

the computation state

See Also:

• CffuState
• Future.State
• Future.state()
• state()

complete

public boolean complete(@Nullable
 T value)

If not already completed, sets the value returned by get() and related methods to the given value.

Parameters:

value - the result value

Returns:

true if this invocation caused this Cffu to transition to a completed state, else false

completeAsync

public Cffu<T> completeAsync(Supplier<? extends T> supplier)

Completes this Cffu with the result of the given Supplier function invoked from an asynchronous task using defaultExecutor().

Parameters:

supplier - a function returning the value to be used to complete this Cffu

Returns:

this Cffu

completeAsync

public Cffu<T> completeAsync(Supplier<? extends T> supplier,
 Executor executor)

Completes this Cffu with the result of the given Supplier function invoked from an asynchronous task using the given executor.

Parameters:

supplier - a function returning the value to be used to complete this Cffu

executor - the executor to use for asynchronous execution

Returns:

this Cffu

completeExceptionally

public boolean completeExceptionally(Throwable ex)

If not already completed, causes invocations of get() and related methods to throw the given exception.

Parameters:

ex - the exception

Returns:

true if this invocation caused this Cffu to transition to a completed state, else false

cancel

public boolean cancel(boolean mayInterruptIfRunning)

If not already completed, completes this Cffu with a CancellationException. Dependent Cffus that have not already completed will also complete exceptionally, with a CompletionException caused by this CancellationException.

Specified by:

cancel in interface Future<T>

Parameters:

mayInterruptIfRunning - this value has no effect in this implementation because interrupts are not used to control processing.

Returns:

true if this task is now cancelled

minimalCompletionStage

@Contract(pure=true)
public CompletionStage<T> minimalCompletionStage()

Returns a new CompletionStage that is completed normally with the same value as this CompletableFuture when it completes normally, and cannot be independently completed or otherwise used in ways not defined by the methods of interface CompletionStage. If this CompletableFuture completes exceptionally, then the returned CompletionStage completes exceptionally with a CompletionException with this exception as cause.

CAUTION:
if run on old Java 8, just return a Cffu with a *normal* underlying CompletableFuture which is NOT with a *minimal* CompletionStage.

demo code about re-config methods of Cffu:

cffu2 = cffu
     .resetCffuFactory(cffuFactory2) // reset to use config from cffuFactory2
     .minimalCompletionStage();      // restrict to methods of CompletionStage
 

See Also:

• resetCffuFactory(CffuFactory)
• CompletableFuture.minimalCompletionStage()

resetCffuFactory

@Contract(pure=true)
public Cffu<T> resetCffuFactory(CffuFactory cffuFactory)

Returns a new Cffu with given CffuFactory(contained configuration) that is completed normally with the same value as this Cffu when it completes normally. If this Cffu completes exceptionally, then the returned Cffu completes exceptionally with a CompletionException with this exception as cause.

demo code about re-config methods of Cffu:

cffu2 = cffu
     .resetCffuFactory(cffuFactory2) // reset to use config from cffuFactory2
     .minimalCompletionStage();      // restrict to methods of CompletionStage
 

Parameters:

cffuFactory - cffuFactory contained configuration

Returns:

the new Cffu

See Also:

• minimalCompletionStage()

toCompletableFuture

@Contract(pure=true)
public CompletableFuture<T> toCompletableFuture()

Returns a CompletableFuture maintaining the same completion properties as this stage.

call CompletableFuture.toCompletableFuture() method of the underlying CompletableFuture: underlyingCf.toCompletableFuture(); if you need the underlying CompletableFuture instance, call method cffuUnwrap().

CompletableFutureUtils.toCompletableFutureArray(CompletionStage[]) is the batch operation to this method.

Specified by:

toCompletableFuture in interface CompletionStage<T>

Returns:

the CompletableFuture

See Also:

• CompletionStage.toCompletableFuture()
• cffuUnwrap()
• CompletableFutureUtils.toCompletableFutureArray(CompletionStage[])

copy

@Contract(pure=true)
public Cffu<T> copy()

Returns a new Cffu that is completed normally with the same value as this Cffu when it completes normally. If this Cffu completes exceptionally, then the returned Cffu completes exceptionally with a CompletionException with this exception as cause. The behavior is equivalent to thenApply(x -> x). This method may be useful as a form of "defensive copying", to prevent clients from completing, while still being able to arrange dependent actions.

Returns:

the new Cffu

defaultExecutor

@Contract(pure=true)
public Executor defaultExecutor()

Returns the default Executor used for async methods that do not specify an Executor. Config from the CffuFactory.defaultExecutor(), and can re-configured by resetCffuFactory(CffuFactory).

Returns:

the default executor

See Also:

• CffuFactory.defaultExecutor()
• CffuFactory.builder(Executor)
• cffuFactory()

cffuFactory

@Contract(pure=true)
public CffuFactory cffuFactory()

Returns the CffuFactory of this Cffu. This can be re-configured by resetCffuFactory(CffuFactory).

Returns:

the CffuFactory

See Also:

• defaultExecutor()

forbidObtrudeMethods

@Contract(pure=true)
public boolean forbidObtrudeMethods()

Returns forbidObtrudeMethods or not. This can be re-configured by resetCffuFactory(CffuFactory).

See Also:

• obtrudeValue(Object)
• obtrudeException(Throwable)
• CffuFactory.forbidObtrudeMethods()
• CffuFactoryBuilder.forbidObtrudeMethods(boolean)

isMinimalStage

@Contract(pure=true)
public boolean isMinimalStage()

Returns whether is a minimal stage or not.

create a minimal stage by below methods:

• CffuFactory.completedStage(Object)
• CffuFactory.failedStage(Throwable)
• minimalCompletionStage()
• CffuFactory.toCffu(CompletionStage), this method return a minimal stage when input aminimal stage, otherwise return a normal stage.

cffuUnwrap

@Contract(pure=true)
public CompletableFuture<T> cffuUnwrap()

Returns the underlying CompletableFuture.

CffuFactory.toCffu(CompletionStage) is inverse operation to this method. CffuFactory.cffuArrayUnwrap(Cffu[]) is the batch operation to this method.

Returns:

the underlying CompletableFuture

See Also:

• CffuFactory.toCffu(CompletionStage)
• CffuFactory.cffuArrayUnwrap(Cffu[])
• toCompletableFuture()

getNumberOfDependents

@Contract(pure=true)
public int getNumberOfDependents()

Returns the estimated number of Cffus whose completions are awaiting completion of this Cffu. This method is designed for use in monitoring system state, not for synchronization control.

Returns:

the number of dependent Cffus

See Also:

• CompletableFuture.getNumberOfDependents()

obtrudeValue

public void obtrudeValue(@Nullable
 T value)

Forcibly sets or resets the value subsequently returned by method get() and related methods, whether or not already completed. This method is designed for use only in error recovery actions, and even in such situations may result in ongoing dependent completions using established versus overwritten outcomes.

Parameters:

value - the completion value

See Also:

• CffuFactoryBuilder.forbidObtrudeMethods(boolean)
• CffuFactory.forbidObtrudeMethods()

obtrudeException

public void obtrudeException(Throwable ex)

Forcibly causes subsequent invocations of method get() and related methods to throw the given exception, whether or not already completed. This method is designed for use only in error recovery actions, and even in such situations may result in ongoing dependent completions using established versus overwritten outcomes.

Parameters:

ex - the exception

Throws:

NullPointerException - if the exception is null

See Also:

• CffuFactoryBuilder.forbidObtrudeMethods(boolean)
• CffuFactory.forbidObtrudeMethods()

newIncompleteFuture

@Contract(pure=true)
public <U> Cffu<U> newIncompleteFuture()

Returns a new incomplete Cffu with CompletableFuture of the type to be returned by a CompletionStage method. Subclasses of CompletableFuture should normally override this method to return an instance of the same class as this CompletableFuture. The default implementation returns an instance of class CompletableFuture.

NOTE:
this method existed mainly for API compatibility to CompletableFuture, prefer CffuFactory.newIncompleteCffu().

CAUTION:
for minimal stage instance(isMinimalStage()), if run on old Java 8, just return a Cffu with a *normal* underlying CompletableFuture which is NOT with a *minimal* CompletionStage.

See Also:

• CffuFactory.newIncompleteCffu()
• CompletableFuture.newIncompleteFuture()

toString

@Contract(pure=true)
public String toString()

Returns a string identifying this Cffu, as well as its completion state.

The state, in brackets, contains the String "Completed Normally" or the String "Completed Exceptionally", or the String "Not completed" followed by the number of Cffus dependent upon its completion, if any.

Overrides:

toString in class Object

Returns:

a string identifying this Cffu, as well as its state

See Also:

• CompletableFuture.toString()