Package io.foldright.cffu

Class CffuFactory

java.lang.Object

io.foldright.cffu.CffuFactory

@ThreadSafe
public final class CffuFactory
extends Object

This class CffuFactory is equivalent to CompletableFuture, contains the static (factory) methods of CompletableFuture.

The methods that equivalent to the instance methods of CompletableFuture is in Cffu class.

Use builder(Executor) to config and build CffuFactory.

About factory methods convention of CffuFactory:

• factory methods return Cffu instead of CompletableFuture.
• only provide varargs methods for multiple Cffu/CF input arguments; if you have List input, use static utility methods cffuListToArray(List) or CompletableFutureUtils.completableFutureListToArray(List) to convert it to array first.

Author:

Jerry Lee (oldratlee at gmail dot com), HuHao (995483610 at qq dot com)

See Also:

• Cffu
• CompletableFuture

Method Summary

Modifier and Type	Method	Description
Cffu<Void>	allFailFastOf(CompletionStage<?>... cfs)	Returns a new Cffu that is completed normally when all the given stages complete normally; If any of the given stages complete exceptionally, then the returned Cffu also does so, WITHOUT waiting other incomplete given stages, with a CompletionException holding this exception as its cause.
Cffu<Void>	allOf(CompletionStage<?>... cfs)	Returns a new Cffu that is completed when all the given stages complete; If any of the given stages complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.
final <T> Cffu<List<T>>	allResultsFailFastOf(CompletionStage<? extends T>... cfs)	Returns a new Cffu that is completed normally with a list containing the successful results of all given stages when all the given stages complete normally; If any of the given stages complete exceptionally, then the returned Cffu also does so, WITHOUT waiting other incomplete given stages, with a CompletionException holding this exception as its cause.
final <T> Cffu<List<T>>	allResultsOf(CompletionStage<? extends T>... cfs)	Returns a new Cffu that is completed normally with a list containing the successful results of all given stages when all the given stages complete; If any of the given stages complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.
final <T> Cffu<List<T>>	allSuccessResultsOf(T valueIfFailed, CompletionStage<? extends T>... cfs)	Returns a new Cffu that is completed normally with a list containing the successful results of all given stages when all the given stages complete; The list of results is in the same order as the input list, and if any of given stages complete exceptionally, their corresponding position will contain valueIfFailed (which is indistinguishable from the stage having a successful value of valueIfFailed).
<T1, T2> Cffu<Tuple2<T1,T2>>	allSuccessTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2)	Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	allSuccessTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3)	Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	allSuccessTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4)	Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	allSuccessTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4, CompletionStage<? extends T5> cf5)	Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.
<T1, T2> Cffu<Tuple2<T1,T2>>	allTupleFailFastOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2)	Tuple variant of allResultsFailFastOf(CompletionStage[]).
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	allTupleFailFastOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3)	Tuple variant of allResultsFailFastOf(CompletionStage[]).
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	allTupleFailFastOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4)	Tuple variant of allResultsFailFastOf(CompletionStage[]).
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	allTupleFailFastOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4, CompletionStage<? extends T5> cf5)	Tuple variant of allResultsFailFastOf(CompletionStage[]).
<T1, T2> Cffu<Tuple2<T1,T2>>	allTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2)	Tuple variant of allResultsOf(CompletionStage[]).
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	allTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3)	Tuple variant of allResultsOf(CompletionStage[]).
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	allTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4)	Tuple variant of allResultsOf(CompletionStage[]).
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	allTupleOf(CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4, CompletionStage<? extends T5> cf5)	Tuple variant of allResultsOf(CompletionStage[]).
final <T> Cffu<T>	anyOf(CompletionStage<? extends T>... cfs)	Returns a new Cffu that is completed with the same successful result or exception of any of the given stages when one stage completes.
final <T> Cffu<T>	anySuccessOf(CompletionStage<? extends T>... cfs)	Returns a new Cffu that completed normally when any of the given stages complete normally, with the same result; Otherwise, when all the given stages complete exceptionally, the returned Cffu also does so, with a CompletionException holding an exception from any of the given stages as its cause.
static CffuFactoryBuilder	builder(Executor defaultExecutor)	Returns a CffuFactoryBuilder with defaultExecutor setting.
static <T> Cffu<T>[]	cffuListToArray(List<Cffu<T>> cffuList)	Convert Cffu list to Cffu array.
<T> Cffu<T>	completedFuture(T value)	Returns a new Cffu that is already completed with the given value.
<T> CompletionStage<T>	completedStage(T value)	Returns a new CompletionStage that is already completed with the given value and supports only those methods in interface CompletionStage.
Executor	defaultExecutor()	Returns the default Executor used for async methods that do not specify an Executor.
Executor	delayedExecutor(long delay, TimeUnit unit)	Returns a new Executor that submits a task to the default executor after the given delay (or no delay if non-positive).
Executor	delayedExecutor(long delay, TimeUnit unit, Executor executor)	Returns a new Executor that submits a task to the given base executor after the given delay (or no delay if non-positive).
<T> Cffu<T>	failedFuture(Throwable ex)	Returns a new Cffu that is already completed exceptionally with the given exception.
<T> CompletionStage<T>	failedStage(Throwable ex)	Returns a new CompletionStage that is already completed exceptionally with the given exception and supports only those methods in interface CompletionStage.
boolean	forbidObtrudeMethods()	Returns forbidObtrudeMethods or not.
final <T> Cffu<List<T>>	mostSuccessResultsOf(T valueIfNotSuccess, long timeout, TimeUnit unit, CompletionStage<? extends T>... cfs)	Returns a new Cffu that is completed normally with a list containing the successful results of the given stages before the given timeout (aka as many results as possible in the given time); The list of results is in the same order as the input list, and if any of given stages complete exceptionally or are incomplete, their corresponding positions will contain valueIfNotSuccess (which is indistinguishable from the stage having a successful value of valueIfNotSuccess).
<T1, T2> Cffu<Tuple2<T1,T2>>	mostSuccessTupleOf(long timeout, TimeUnit unit, CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2)	Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mostSuccessTupleOf(long timeout, TimeUnit unit, CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3)	Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mostSuccessTupleOf(long timeout, TimeUnit unit, CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4)	Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mostSuccessTupleOf(long timeout, TimeUnit unit, CompletionStage<? extends T1> cf1, CompletionStage<? extends T2> cf2, CompletionStage<? extends T3> cf3, CompletionStage<? extends T4> cf4, CompletionStage<? extends T5> cf5)	Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.
Cffu<Void>	mRunAnyAsync(Runnable... actions)	Shortcut to method anyOf, wraps input actions to Cffu by runAsync(Runnable).
Cffu<Void>	mRunAnyAsync(Executor executor, Runnable... actions)	Shortcut to method anyOf, wraps input actions to Cffu by runAsync(Runnable, Executor).
Cffu<Void>	mRunAnySuccessAsync(Runnable... actions)	Shortcut to method anySuccessOf, wraps input actions to Cffu by runAsync(Runnable).
Cffu<Void>	mRunAnySuccessAsync(Executor executor, Runnable... actions)	Shortcut to method anySuccessOf, wraps input actions to Cffu by runAsync(Runnable, Executor).
Cffu<Void>	mRunAsync(Runnable... actions)	Shortcut to method allOf, wraps input actions to Cffu by runAsync(Runnable).
Cffu<Void>	mRunAsync(Executor executor, Runnable... actions)	Shortcut to method allOf, wraps input actions to Cffu by runAsync(Runnable, Executor).
Cffu<Void>	mRunFailFastAsync(Runnable... actions)	Shortcut to method allFailFastOf, wraps input actions to Cffu by runAsync(Runnable).
Cffu<Void>	mRunFailFastAsync(Executor executor, Runnable... actions)	Shortcut to method allFailFastOf, wraps input actions to Cffu by runAsync(Runnable, Executor).
final <T> Cffu<List<T>>	mSupplyAllSuccessAsync(Executor executor, T valueIfFailed, Supplier<? extends T>... suppliers)	Shortcut to method allSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).
final <T> Cffu<List<T>>	mSupplyAllSuccessAsync(T valueIfFailed, Supplier<? extends T>... suppliers)	Shortcut to method allSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyAllSuccessTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyAllSuccessTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyAllSuccessTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyAllSuccessTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.
final <T> Cffu<T>	mSupplyAnyAsync(Executor executor, Supplier<? extends T>... suppliers)	Shortcut to method anySuccessOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).
final <T> Cffu<T>	mSupplyAnyAsync(Supplier<? extends T>... suppliers)	Shortcut to method anyOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
final <T> Cffu<T>	mSupplyAnySuccessAsync(Executor executor, Supplier<? extends T>... suppliers)	Shortcut to method anySuccessOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).
final <T> Cffu<T>	mSupplyAnySuccessAsync(Supplier<? extends T>... suppliers)	Shortcut to method anySuccessOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
final <T> Cffu<List<T>>	mSupplyAsync(Executor executor, Supplier<? extends T>... suppliers)	Shortcut to method allResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).
final <T> Cffu<List<T>>	mSupplyAsync(Supplier<? extends T>... suppliers)	Shortcut to method allResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
final <T> Cffu<List<T>>	mSupplyFailFastAsync(Executor executor, Supplier<? extends T>... suppliers)	Shortcut to method allResultsFailFastOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).
final <T> Cffu<List<T>>	mSupplyFailFastAsync(Supplier<? extends T>... suppliers)	Shortcut to method allResultsFailFastOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
final <T> Cffu<List<T>>	mSupplyMostSuccessAsync(Executor executor, T valueIfNotSuccess, long timeout, TimeUnit unit, Supplier<? extends T>... suppliers)	Shortcut to method mostSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
final <T> Cffu<List<T>>	mSupplyMostSuccessAsync(T valueIfNotSuccess, long timeout, TimeUnit unit, Supplier<? extends T>... suppliers)	Shortcut to method mostSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyTupleAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyAsync(Supplier[]).
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyAsync(Supplier[]).
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyAsync(Supplier[]).
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyTupleAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyAsync(Supplier[]).
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyTupleFailFastAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyTupleFailFastAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyTupleFailFastAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyTupleFailFastAsync(Executor executor, Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).
<T1, T2> Cffu<Tuple2<T1,T2>>	mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2)	Tuple variant of mSupplyFailFastAsync(Supplier[]).
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3)	Tuple variant of mSupplyFailFastAsync(Supplier[]).
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4)	Tuple variant of mSupplyFailFastAsync(Supplier[]).
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1, Supplier<? extends T2> supplier2, Supplier<? extends T3> supplier3, Supplier<? extends T4> supplier4, Supplier<? extends T5> supplier5)	Tuple variant of mSupplyFailFastAsync(Supplier[]).
<T> Cffu<T>	newIncompleteCffu()	Return an incomplete Cffu, equivalent to CompletableFuture() constructor.
Cffu<Void>	runAsync(Runnable action)	Returns a new Cffu that is asynchronously completed by a task running in the defaultExecutor() after it runs the given action.
Cffu<Void>	runAsync(Runnable action, Executor executor)	Returns a new Cffu that is asynchronously completed by a task running in the given executor after it runs the given action.
<T> Cffu<T>	supplyAsync(Supplier<T> supplier)	Returns a new Cffu that is asynchronously completed by a task running in the defaultExecutor() with the value obtained by calling the given Supplier.
<T> Cffu<T>	supplyAsync(Supplier<T> supplier, Executor executor)	Returns a new Cffu that is asynchronously completed by a task running in the given executor with the value obtained by calling the given Supplier.
<T> Cffu<T>	toCffu(CompletionStage<T> stage)	Returns a Cffu maintaining the same completion properties as the given stage and this CffuFactory config.
final <T> Cffu<T>[]	toCffuArray(CompletionStage<T>... stages)	Converts input CompletionStage(including CompletableFuture) array element by toCffu(CompletionStage).
CffuFactory	withDefaultExecutor(Executor defaultExecutor)	Returns a CffuFactory from this CffuFactory with the defaultExecutor.

Methods inherited from class java.lang.Object

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

Method Details

builder

@Contract(pure=true)
public static CffuFactoryBuilder builder(Executor defaultExecutor)

Returns a CffuFactoryBuilder with defaultExecutor setting.

See Also:

• Cffu.defaultExecutor()
• defaultExecutor()

withDefaultExecutor

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

Returns a CffuFactory from this CffuFactory with the defaultExecutor.

newIncompleteCffu

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

Return an incomplete Cffu, equivalent to CompletableFuture() constructor.

In general, you should not use this method in application code, prefer other factory methods.

See Also:

• CompletableFuture()

supplyAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `runAsync`")
public <T> Cffu<T> supplyAsync(Supplier<T> supplier)

Returns a new Cffu that is asynchronously completed by a task running in the defaultExecutor() with the value obtained by calling the given Supplier.

Type Parameters:

T - the function's return type

Parameters:

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

supplyAsync

@CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `runAsync`")
public <T> Cffu<T> supplyAsync(Supplier<T> supplier,
 Executor executor)

Returns a new Cffu that is asynchronously completed by a task running in the given executor with the value obtained by calling the given Supplier.

Type Parameters:

T - the function's return type

Parameters:

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

executor - the executor to use for asynchronous execution

runAsync

public Cffu<Void> runAsync(Runnable action)

Returns a new Cffu that is asynchronously completed by a task running in the defaultExecutor() after it runs the given action.

Parameters:

action - the action to run before completing the returned Cffu

runAsync

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

Returns a new Cffu that is asynchronously completed by a task running in the given executor after it runs the given action.

Parameters:

action - the action to run before completing the returned Cffu

executor - the executor to use for asynchronous execution

mSupplyFailFastAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyFailFastAsync(Supplier<? extends T>... suppliers)

Shortcut to method allResultsFailFastOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the allResultsFailFastOf documentation for the rules of result computation.

mSupplyFailFastAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyFailFastAsync(Executor executor,
 Supplier<? extends T>... suppliers)

Shortcut to method allResultsFailFastOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).

See the allResultsFailFastOf documentation for the rules of result computation.

mSupplyAllSuccessAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyAllSuccessAsync(@Nullable
 T valueIfFailed,
 Supplier<? extends T>... suppliers)

Shortcut to method allSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the allSuccessResultsOf documentation for the rules of result computation.

mSupplyAllSuccessAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyAllSuccessAsync(Executor executor,
 @Nullable
 T valueIfFailed,
 Supplier<? extends T>... suppliers)

Shortcut to method allSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).

See the allSuccessResultsOf documentation for the rules of result computation.

mSupplyMostSuccessAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyMostSuccessAsync(@Nullable
 T valueIfNotSuccess,
 long timeout,
 TimeUnit unit,
 Supplier<? extends T>... suppliers)

Shortcut to method mostSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the mostSuccessResultsOf documentation for the rules of result computation.

mSupplyMostSuccessAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyMostSuccessAsync(Executor executor,
 @Nullable
 T valueIfNotSuccess,
 long timeout,
 TimeUnit unit,
 Supplier<? extends T>... suppliers)

Shortcut to method mostSuccessResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the mostSuccessResultsOf documentation for the rules of result computation.

mSupplyAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyAsync(Supplier<? extends T>... suppliers)

Shortcut to method allResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the allResultsOf documentation for the rules of result computation.

mSupplyAsync

@SafeVarargs
public final <T> Cffu<List<T>> mSupplyAsync(Executor executor,
 Supplier<? extends T>... suppliers)

Shortcut to method allResultsOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).

See the allResultsOf documentation for the rules of result computation.

mSupplyAnySuccessAsync

@SafeVarargs
public final <T> Cffu<T> mSupplyAnySuccessAsync(Supplier<? extends T>... suppliers)

Shortcut to method anySuccessOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the anySuccessOf documentation for the rules of result computation.

mSupplyAnySuccessAsync

@SafeVarargs
public final <T> Cffu<T> mSupplyAnySuccessAsync(Executor executor,
 Supplier<? extends T>... suppliers)

Shortcut to method anySuccessOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).

See the anySuccessOf documentation for the rules of result computation.

mSupplyAnyAsync

@SafeVarargs
public final <T> Cffu<T> mSupplyAnyAsync(Supplier<? extends T>... suppliers)

Shortcut to method anyOf, wraps input suppliers to Cffu by supplyAsync(Supplier).

See the anySuccessOf documentation for the rules of result computation.

mSupplyAnyAsync

@SafeVarargs
public final <T> Cffu<T> mSupplyAnyAsync(Executor executor,
 Supplier<? extends T>... suppliers)

Shortcut to method anySuccessOf, wraps input suppliers to Cffu by supplyAsync(Supplier, Executor).

See the anyOf documentation for the rules of result computation.

mRunFailFastAsync

public Cffu<Void> mRunFailFastAsync(Runnable... actions)

Shortcut to method allFailFastOf, wraps input actions to Cffu by runAsync(Runnable).

See the allFailFastOf documentation for the rules of result computation.

mRunFailFastAsync

public Cffu<Void> mRunFailFastAsync(Executor executor,
 Runnable... actions)

Shortcut to method allFailFastOf, wraps input actions to Cffu by runAsync(Runnable, Executor).

See the allFailFastOf documentation for the rules of result computation.

mRunAsync

public Cffu<Void> mRunAsync(Runnable... actions)

Shortcut to method allOf, wraps input actions to Cffu by runAsync(Runnable).

See the allOf documentation for the rules of result computation.

mRunAsync

public Cffu<Void> mRunAsync(Executor executor,
 Runnable... actions)

Shortcut to method allOf, wraps input actions to Cffu by runAsync(Runnable, Executor).

See the allOf documentation for the rules of result computation.

mRunAnySuccessAsync

public Cffu<Void> mRunAnySuccessAsync(Runnable... actions)

Shortcut to method anySuccessOf, wraps input actions to Cffu by runAsync(Runnable).

See the anySuccessOf documentation for the rules of result computation.

mRunAnySuccessAsync

public Cffu<Void> mRunAnySuccessAsync(Executor executor,
 Runnable... actions)

Shortcut to method anySuccessOf, wraps input actions to Cffu by runAsync(Runnable, Executor).

See the anySuccessOf documentation for the rules of result computation.

mRunAnyAsync

public Cffu<Void> mRunAnyAsync(Runnable... actions)

Shortcut to method anyOf, wraps input actions to Cffu by runAsync(Runnable).

See the anyOf documentation for the rules of result computation.

mRunAnyAsync

public Cffu<Void> mRunAnyAsync(Executor executor,
 Runnable... actions)

Shortcut to method anyOf, wraps input actions to Cffu by runAsync(Runnable, Executor).

See the anyOf documentation for the rules of result computation.

mSupplyTupleFailFastAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyFailFastAsync(Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyTupleFailFastAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyFailFastAsync(Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyTupleFailFastAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyFailFastAsync(Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyTupleFailFastAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyTupleFailFastAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyFailFastAsync(Supplier[]).

mSupplyTupleFailFastAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyTupleFailFastAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyAllSuccessTupleAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyAllSuccessTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyAllSuccessTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyAllSuccessTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyAllSuccessTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyAllSuccessAsync(Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyAllSuccessTupleAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyAllSuccessTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyAllSuccessAsync(Executor, Object, Supplier[]) with null valueIfFailed.

If any of the provided suppliers fails, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyMostSuccessTupleAsync(long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyMostSuccessTupleAsync(Executor executor,
 long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyMostSuccessTupleAsync(long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyMostSuccessTupleAsync(Executor executor,
 long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyMostSuccessTupleAsync(long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyMostSuccessTupleAsync(Executor executor,
 long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyMostSuccessTupleAsync(long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyMostSuccessAsync(Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyMostSuccessTupleAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyMostSuccessTupleAsync(Executor executor,
 long timeout,
 TimeUnit unit,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyMostSuccessAsync(Executor, Object, long, TimeUnit, Supplier[]) with null valueIfNotSuccess.

If any of the provided suppliers is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mSupplyTupleAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyAsync(Supplier[]).

mSupplyTupleAsync

public <T1,
T2> Cffu<Tuple2<T1,T2>> mSupplyTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyTupleAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyAsync(Supplier[]).

mSupplyTupleAsync

public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mSupplyTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyTupleAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyAsync(Supplier[]).

mSupplyTupleAsync

public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mSupplyTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

mSupplyTupleAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyTupleAsync(Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyAsync(Supplier[]).

mSupplyTupleAsync

public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mSupplyTupleAsync(Executor executor,
 Supplier<? extends T1> supplier1,
 Supplier<? extends T2> supplier2,
 Supplier<? extends T3> supplier3,
 Supplier<? extends T4> supplier4,
 Supplier<? extends T5> supplier5)

Tuple variant of mSupplyFailFastAsync(Executor, Supplier[]).

allResultsFailFastOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> allResultsFailFastOf(CompletionStage<? extends T>... cfs)

Returns a new Cffu that is completed normally with a list containing the successful results of all given stages when all the given stages complete normally; If any of the given stages complete exceptionally, then the returned Cffu also does so, WITHOUT waiting other incomplete given stages, with a CompletionException holding this exception as its cause. If no stages are provided, returns a Cffu completed with the value empty list.

The list of results is in the same order as the input list.

This method is the same as allResultsOf method except for the fail-fast behavior.

Throws:

NullPointerException - if the cfs param or any of its elements are null

See Also:

• the equivalent Guava method allAsList()

allSuccessResultsOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> allSuccessResultsOf(@Nullable
 T valueIfFailed,
 CompletionStage<? extends T>... cfs)

Returns a new Cffu that is completed normally with a list containing the successful results of all given stages when all the given stages complete; The list of results is in the same order as the input list, and if any of given stages complete exceptionally, their corresponding position will contain valueIfFailed (which is indistinguishable from the stage having a successful value of valueIfFailed). If no stages are provided, returns a Cffu completed with the value empty list.

The list of results is in the same order as the input list.

This method differs from allResultsFailFastOf method in that it's tolerant of failed stages for any of the items, representing them as valueIfFailed in the result list.

Parameters:

valueIfFailed - the value used as result if the input stage completed exceptionally

Throws:

NullPointerException - if the cfs param or any of its elements is null

See Also:

• Cffu.getSuccessNow(Object)
• the equivalent Guava method successfulAsList()

mostSuccessResultsOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> mostSuccessResultsOf(@Nullable
 T valueIfNotSuccess,
 long timeout,
 TimeUnit unit,
 CompletionStage<? extends T>... cfs)

Returns a new Cffu that is completed normally with a list containing the successful results of the given stages before the given timeout (aka as many results as possible in the given time); The list of results is in the same order as the input list, and if any of given stages complete exceptionally or are incomplete, their corresponding positions will contain valueIfNotSuccess (which is indistinguishable from the stage having a successful value of valueIfNotSuccess). If no stages are provided, returns a Cffu completed with the value empty list.

The list of results is in the same order as the input list.

This method differs from allResultsFailFastOf method in that it's tolerant of failed or incomplete stages for any of the items, representing them as valueIfNotSuccess in the result list.

Parameters:

valueIfNotSuccess - the value used as result if the input stage not completed normally

timeout - how long to wait in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Throws:

NullPointerException - if the cfs param or any of its elements are null

See Also:

• Cffu.getSuccessNow(Object)

allResultsOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> allResultsOf(CompletionStage<? extends T>... cfs)

Returns a new Cffu that is completed normally with a list containing the successful results of all given stages when all the given stages complete; If any of the given stages complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause. If no stages are provided, returns a Cffu completed with the value empty list.

The list of results is in the same order as the input list.

Comparing the waiting-all-complete behavior of this method, the fail-fast behavior of allResultsFailFastOf method is more responsive to user and generally more desired in the application.

This method is the same as allOf method, except that the returned Cffu contains the results of the given stages.

Throws:

NullPointerException - if the cfs param or any of its elements are null

allFailFastOf

@Contract(pure=true)
public Cffu<Void> allFailFastOf(CompletionStage<?>... cfs)

Returns a new Cffu that is completed normally when all the given stages complete normally; If any of the given stages complete exceptionally, then the returned Cffu also does so, WITHOUT waiting other incomplete given stages, with a CompletionException holding this exception as its cause. If no stages are provided, returns a Cffu completed with the value null.

The successful results, if any, of the given stages are not reflected in the returned Cffu (Cffu<Void>), but may be obtained by inspecting them individually; Or using below methods reflected results in the returned Cffu which are more convenient, safer and best-practice of concurrency:

• allResultsFailFastOf, allTupleFailFastOf
• allSuccessResultsOf, allSuccessTupleOf
• mostSuccessResultsOf, mostSuccessTupleOf
• allResultsOf, allTupleOf

This method is the same as allOf method except for the fail-fast behavior.

Throws:

NullPointerException - if the cfs param or any of its elements are null

See Also:

• the equivalent Guava method whenAllSucceed()

allOf

@CheckReturnValue(explanation="should use the returned Cffu; forget to call its `join()` method?")
@Contract(pure=true)
public Cffu<Void> allOf(CompletionStage<?>... cfs)

Returns a new Cffu that is completed when all the given stages complete; If any of the given stages complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause. If no stages are provided, returns a Cffu completed with the value null.

The successful results, if any, of the given stages are not reflected in the returned Cffu (Cffu<Void>), but may be obtained by inspecting them individually; Or using below methods reflected results in the returned Cffu which are more convenient, safer and best-practice of concurrency:

• allResultsOf, allTupleOf
• allResultsFailFastOf, allTupleFailFastOf
• allSuccessResultsOf, allSuccessTupleOf
• mostSuccessResultsOf, mostSuccessTupleOf

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

Throws:

NullPointerException - if the cfs param or any of its elements are null

See Also:

• the equivalent Guava method whenAllComplete()

anySuccessOf

@SafeVarargs
public final <T> Cffu<T> anySuccessOf(CompletionStage<? extends T>... cfs)

Returns a new Cffu that completed normally when any of the given stages complete normally, with the same result; Otherwise, when all the given stages complete exceptionally, the returned Cffu also does so, with a CompletionException holding an exception from any of the given stages as its cause. If no stages are provided, returns a new Cffu that is already completed exceptionally with a NoCfsProvidedException.

This method differs from anyOf method in that this method is any-success instead of the any-complete behavior of method anyOf.

Throws:

NullPointerException - if the cfs param or any of its elements are null

anyOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<T> anyOf(CompletionStage<? extends T>... cfs)

Returns a new Cffu that is completed with the same successful result or exception of any of the given stages when one stage completes. If no stages are provided, returns an incomplete Cffu.

Comparing the any-complete behavior of this method, the any-success behavior of method anySuccessOf is more responsive to user and generally more desired in the application.

Throws:

NullPointerException - if the cfs param or any of its elements are null

allTupleFailFastOf

@Contract(pure=true)
public <T1,
T2> Cffu<Tuple2<T1,T2>> allTupleFailFastOf(CompletionStage<? extends T1> cf1,
 CompletionStage<? extends T2> cf2)

Tuple variant of allResultsFailFastOf(CompletionStage[]).

allTupleFailFastOf

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

Tuple variant of allResultsFailFastOf(CompletionStage[]).

allTupleFailFastOf

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

Tuple variant of allResultsFailFastOf(CompletionStage[]).

allTupleFailFastOf

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

Tuple variant of allResultsFailFastOf(CompletionStage[]).

allSuccessTupleOf

@Contract(pure=true)
public <T1,
T2> Cffu<Tuple2<T1,T2>> allSuccessTupleOf(CompletionStage<? extends T1> cf1,
 CompletionStage<? extends T2> cf2)

Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.

If any of the provided stages fails, its corresponding position will contain null (which is indistinguishable from the stage having a successful value of null).

allSuccessTupleOf

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

Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.

If any of the provided stages fails, its corresponding position will contain null (which is indistinguishable from the stage having a successful value of null).

allSuccessTupleOf

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

Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.

If any of the provided stages fails, its corresponding position will contain null (which is indistinguishable from the stage having a successful value of null).

allSuccessTupleOf

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

Tuple variant of allSuccessResultsOf(Object, CompletionStage[]) with null valueIfFailed.

If any of the provided stages fails, its corresponding position will contain null (which is indistinguishable from the stage having a successful value of null).

mostSuccessTupleOf

@Contract(pure=true)
public <T1,
T2> Cffu<Tuple2<T1,T2>> mostSuccessTupleOf(long timeout,
 TimeUnit unit,
 CompletionStage<? extends T1> cf1,
 CompletionStage<? extends T2> cf2)

Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.

If any of the provided stages is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mostSuccessTupleOf

@Contract(pure=true)
public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> mostSuccessTupleOf(long timeout,
 TimeUnit unit,
 CompletionStage<? extends T1> cf1,
 CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3)

Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.

If any of the provided stages is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mostSuccessTupleOf

@Contract(pure=true)
public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> mostSuccessTupleOf(long timeout,
 TimeUnit unit,
 CompletionStage<? extends T1> cf1,
 CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3,
 CompletionStage<? extends T4> cf4)

Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.

If any of the provided stages is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

mostSuccessTupleOf

@Contract(pure=true)
public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> mostSuccessTupleOf(long timeout,
 TimeUnit unit,
 CompletionStage<? extends T1> cf1,
 CompletionStage<? extends T2> cf2,
 CompletionStage<? extends T3> cf3,
 CompletionStage<? extends T4> cf4,
 CompletionStage<? extends T5> cf5)

Tuple variant of mostSuccessResultsOf(Object, long, TimeUnit, CompletionStage[]) with null valueIfNotSuccess.

If any of the provided stages is not completed normally, its corresponding position will contain null (which is indistinguishable from the supplier having a successful value of null).

allTupleOf

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

Tuple variant of allResultsOf(CompletionStage[]).

allTupleOf

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

Tuple variant of allResultsOf(CompletionStage[]).

allTupleOf

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

Tuple variant of allResultsOf(CompletionStage[]).

allTupleOf

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

Tuple variant of allResultsOf(CompletionStage[]).

completedFuture

@Contract(pure=true)
public <T> Cffu<T> completedFuture(@Nullable
 T value)

Returns a new Cffu that is already completed with the given value.

Type Parameters:

T - the type of the value

Parameters:

value - the value

Returns:

the completed Cffu

completedStage

@Contract(pure=true)
public <T> CompletionStage<T> completedStage(@Nullable
 T value)

Returns a new CompletionStage that is already completed with the given value and supports only those methods in interface CompletionStage.

CAUTION: if run on old Java 8 (which does not support *minimal* CompletionStage), this method just returns a *normal* Cffu instance which is NOT a *minimal* CompletionStage.

Type Parameters:

T - the type of the value

Parameters:

value - the value

Returns:

the completed CompletionStage

failedFuture

@Contract(pure=true)
public <T> Cffu<T> failedFuture(Throwable ex)

Returns a new Cffu that is already completed exceptionally with the given exception.

Type Parameters:

T - the type of the value

Parameters:

ex - the exception

Returns:

the exceptionally completed Cffu

failedStage

@Contract(pure=true)
public <T> CompletionStage<T> failedStage(Throwable ex)

Returns a new CompletionStage that is already completed exceptionally with the given exception and supports only those methods in interface CompletionStage.

CAUTION: if run on old Java 8 (which does not support *minimal* CompletionStage), this method just returns a *normal* Cffu instance which is NOT a *minimal* CompletionStage.

Type Parameters:

T - the type of the value

Parameters:

ex - the exception

Returns:

the exceptionally completed CompletionStage

toCffu

@Contract(pure=true)
public <T> Cffu<T> toCffu(CompletionStage<T> stage)

Returns a Cffu maintaining the same completion properties as the given stage and this CffuFactory config. If the given stage is already a Cffu and have the this CffuFactory, this method may return the given stage.

Throws:

NullPointerException - if the given stage is null

See Also:

• CompletionStage.toCompletableFuture()
• toCffuArray(CompletionStage[])
• Cffu.withCffuFactory(CffuFactory)

toCffuArray

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<T>[] toCffuArray(CompletionStage<T>... stages)

Converts input CompletionStage(including CompletableFuture) array element by toCffu(CompletionStage).

Throws:

NullPointerException - if the stages param or any of its elements are null

See Also:

• toCffu(CompletionStage)
• CompletableFutureUtils.toCompletableFutureArray(CompletionStage[])

delayedExecutor

@Contract(pure=true)
public Executor delayedExecutor(long delay,
 TimeUnit unit)

Returns a new Executor that submits a task to the default executor after the given delay (or no delay if non-positive). Each delay commences upon invocation of the returned executor's execute method.

Parameters:

delay - how long to delay, in units of unit

unit - a TimeUnit determining how to interpret the delay parameter

Returns:

the new delayed executor

delayedExecutor

@Contract(pure=true)
public Executor delayedExecutor(long delay,
 TimeUnit unit,
 Executor executor)

Returns a new Executor that submits a task to the given base executor after the given delay (or no delay if non-positive). Each delay commences upon invocation of the returned executor's execute method.

Parameters:

delay - how long to delay, in units of unit

unit - a TimeUnit determining how to interpret the delay parameter

executor - the base executor

Returns:

the new delayed executor

cffuListToArray

@Contract(pure=true)
public static <T> Cffu<T>[] cffuListToArray(List<Cffu<T>> cffuList)

Convert Cffu list to Cffu array.

See Also:

• toCffuArray(CompletionStage[])
• CompletableFutureUtils.completableFutureListToArray(List)

defaultExecutor

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

Returns the default Executor used for async methods that do not specify an Executor. Configured by builder(Executor).

Returns:

the default executor

See Also:

• Cffu.defaultExecutor()
• builder(Executor)

forbidObtrudeMethods

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

Returns forbidObtrudeMethods or not.

See Also:

• CffuFactoryBuilder.forbidObtrudeMethods(boolean)