Package io.foldright.cffu

Class CffuFactory

java.lang.Object

io.foldright.cffu.CffuFactory

@Immutable
@ThreadSafe
@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
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 CffuFactoryBuilder to config and build CffuFactory.

About factory methods conventions of CffuFactory:

• factory methods return Cffu instead of CompletableFuture.
• new methods, aka. no equivalent method in CompletableFuture, prefix method name with cffu.
• only provide varargs methods for multiply Cffu/CF input arguments; if you have List input, use static util methods cffuListToArray(List) or completableFutureListToArray(List) to convert it to array first.

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

• CffuFactoryBuilder
• Cffu
• CompletableFuture

Method Summary

Modifier and Type	Method	Description
Cffu<Void>	allOf()	Provided this overloaded method just for resolving "allOf is ambiguous" problem when call allOf with empty arguments: cffuFactory.allOf().
Cffu<Void>	allOf(Cffu<?>... cfs)	Returns a new Cffu that is completed when all the given Cffus complete.
Cffu<Void>	allOf(CompletableFuture<?>... cfs)	Returns a new Cffu that is completed when all the given CompletableFutures complete.
Cffu<Void>	allOfFastFail()	Provided this overloaded method just for resolving "allOfFastFail is ambiguous" problem when call allOfFastFail with empty arguments: cffuFactory.allOfFastFail().
Cffu<Void>	allOfFastFail(Cffu<?>... cfs)	Returns a new Cffu that success when all the given Cffus success, the results(Cffu<Void>) of the given Cffus are not reflected in the returned Cffu, but may be obtained by inspecting them individually.
Cffu<Void>	allOfFastFail(CompletableFuture<?>... cfs)	Returns a new Cffu that success when all the given CompletableFutures success, the results(Cffu<Void>) of the given CompletableFutures are not reflected in the returned Cffu, but may be obtained by inspecting them individually.
Cffu<Object>	anyOf()	Provided this overloaded method just for resolving "anyOf is ambiguous" problem when call anyOf with empty arguments: cffuFactory.anyOf().
Cffu<Object>	anyOf(Cffu<?>... cfs)	Returns a new Cffu that is completed when any of the given Cffus complete, with the same result. Otherwise, if it completed exceptionally, the returned Cffu also does so, with a CompletionException holding this exception as its cause. If no Cffus are provided, returns an incomplete Cffu.
Cffu<Object>	anyOf(CompletableFuture<?>... cfs)	Same as anyOf(Cffu[]) with overloaded argument type CompletableFuture.
Cffu<Object>	anyOfSuccess()	Provided this overloaded method just for resolving "cffuAnyOfSuccess is ambiguous" problem when call anyOfSuccess with empty arguments: cffuFactory.anyOfSuccess().
Cffu<Object>	anyOfSuccess(Cffu<?>... cfs)	Returns a new Cffu that success when any of the given Cffus success, with the same result.
Cffu<Object>	anyOfSuccess(CompletableFuture<?>... cfs)	Returns a new Cffu that success when any of the given CompletableFutures success, with the same result.
<T> Cffu<T>	asCffu(CompletionStage<T> stage)	Wrap an existed CompletableFuture/CompletionStage/Cffu to Cffu.
final <T> Cffu<T>[]	asCffuArray(CompletionStage<T>... stages)	A convenient util method for wrap input CompletableFuture/CompletionStage/Cffu array element by asCffu(CompletionStage).
<T> Cffu<List<T>>	cffuAllOf()	Provided this overloaded method just for resolving "cffuAllOf is ambiguous" problem when call cffuAllOf with empty arguments: cffuFactory.cffuAllOf().
final <T> Cffu<List<T>>	cffuAllOf(Cffu<T>... cfs)	Returns a new Cffu with the results of all the given Cffus, the new Cffu is completed when all the given Cffus complete.
final <T> Cffu<List<T>>	cffuAllOf(CompletableFuture<T>... cfs)	Returns a new Cffu with the results of all the given CompletableFutures, the new Cffu is completed when all the given CompletableFutures complete.
<T> Cffu<List<T>>	cffuAllOfFastFail()	Provided this overloaded method just for resolving "cffuAllOfFastFail is ambiguous" problem when call cffuAllOfFastFail with empty arguments: cffuFactory.cffuAllOfFastFail().
final <T> Cffu<List<T>>	cffuAllOfFastFail(Cffu<T>... cfs)	Returns a new Cffu with the results of all the given Cffus, the new Cffu success when all the given Cffus success.
final <T> Cffu<List<T>>	cffuAllOfFastFail(CompletableFuture<T>... cfs)	Returns a new Cffu with the results of all the given CompletableFutures, the new Cffu success when all the given CompletableFutures success.
<T> Cffu<T>	cffuAnyOf()	Provided this overloaded method just for resolving "cffuAnyOf is ambiguous" problem when call cffuAnyOf with empty arguments: cffuFactory.cffuAnyOf().
final <T> Cffu<T>	cffuAnyOf(Cffu<T>... cfs)	Returns a new Cffu that is completed when any of the given Cffus complete, with the same result.
final <T> Cffu<T>	cffuAnyOf(CompletableFuture<T>... cfs)	Returns a new Cffu that is completed when any of the given CompletableFutures complete, with the same result.
<T> Cffu<T>	cffuAnyOfSuccess()	Provided this overloaded method just for resolving "cffuAnyOfSuccess is ambiguous" problem when call cffuAnyOfSuccess with empty arguments: cffuFactory.cffuAnyOfSuccess().
final <T> Cffu<T>	cffuAnyOfSuccess(Cffu<T>... cfs)	Returns a new Cffu that success when any of the given Cffus success, with the same result.
final <T> Cffu<T>	cffuAnyOfSuccess(CompletableFuture<T>... cfs)	Returns a new Cffu that success when any of the given CompletableFutures success, with the same result.
static <T> CompletableFuture<T>[]	cffuArrayUnwrap(Cffu<T>... cfs)	A convenient util method for unwrap input Cffu array elements by Cffu.cffuUnwrap().
<T1, T2> Cffu<Tuple2<T1,T2>>	cffuCombine(Cffu<T1> cf1, Cffu<T2> cf2)	Returns a new Cffu that is completed when the given two Cffus complete.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	cffuCombine(Cffu<T1> cf1, Cffu<T2> cf2, Cffu<T3> cf3)	Returns a new Cffu that is completed when the given three Cffus complete.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	cffuCombine(Cffu<T1> cf1, Cffu<T2> cf2, Cffu<T3> cf3, Cffu<T4> cf4)	Returns a new Cffu that is completed when the given 4 Cffus complete.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	cffuCombine(Cffu<T1> cf1, Cffu<T2> cf2, Cffu<T3> cf3, Cffu<T4> cf4, Cffu<T5> cf5)	Returns a new Cffu that is completed when the given 5 Cffus complete.
<T1, T2> Cffu<Tuple2<T1,T2>>	cffuCombine(CompletableFuture<T1> cf1, CompletableFuture<T2> cf2)	Returns a new Cffu that is completed when the given two CompletableFutures complete.
<T1, T2, T3> Cffu<Tuple3<T1,T2,T3>>	cffuCombine(CompletableFuture<T1> cf1, CompletableFuture<T2> cf2, CompletableFuture<T3> cf3)	Returns a new Cffu that is completed when the given three CompletableFutures complete.
<T1, T2, T3, T4> Cffu<Tuple4<T1,T2,T3,T4>>	cffuCombine(CompletableFuture<T1> cf1, CompletableFuture<T2> cf2, CompletableFuture<T3> cf3, CompletableFuture<T4> cf4)	Returns a new Cffu that is completed when the given 4 CompletableFutures complete.
<T1, T2, T3, T4, T5> Cffu<Tuple5<T1,T2,T3,T4,T5>>	cffuCombine(CompletableFuture<T1> cf1, CompletableFuture<T2> cf2, CompletableFuture<T3> cf3, CompletableFuture<T4> cf4, CompletableFuture<T5> cf5)	Returns a new Cffu that is completed when the given 5 CompletableFutures complete.
static <T> Cffu<T>[]	cffuListToArray(List<Cffu<T>> cffuList)	Convert Cffu list to Cffu array.
static <T> CompletableFuture<T>[]	completableFutureListToArray(List<CompletableFuture<T>> cfList)	Convert CompletableFuture list to CompletableFuture 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 defaultExecutor.
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.
<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.
static <T> CompletableFuture<T>[]	toCompletableFutureArray(CompletionStage<T>... stages)	A convenient util method for converting input Cffu/CompletableFuture/CompletionStage array element by Cffu.toCompletableFuture()/CompletableFuture.toCompletableFuture()/CompletionStage.toCompletableFuture().

Methods inherited from class java.lang.Object

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

Method Details

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

See Also:

• CompletableFuture.completedFuture(Object)

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, just return a Cffu with a *normal* underneath CompletableFuture which is NOT with a *minimal* CompletionStage.

Type Parameters:

T - the type of the value

Parameters:

value - the value

Returns:

the completed CompletionStage

See Also:

• CompletableFuture.completedStage(Object)
• CompletableFuture.minimalCompletionStage()

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

See Also:

• CompletableFuture.failedFuture(Throwable)

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, just return a Cffu with a *normal* underneath CompletableFuture which is NOT with a *minimal* CompletionStage.

Type Parameters:

T - the type of the value

Parameters:

ex - the exception

Returns:

the exceptionally completed CompletionStage

See Also:

• CompletableFuture.failedStage(Throwable)
• CompletableFuture.minimalCompletionStage()

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

Returns:

the new Cffu

See Also:

• CompletableFuture.runAsync(Runnable)

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

Returns:

the new Cffu

See Also:

• CompletableFuture.runAsync(Runnable, Executor)

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

Returns:

the new Cffu

See Also:

• CompletableFuture.supplyAsync(Supplier)

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

Returns:

the new Cffu

See Also:

• CompletableFuture.supplyAsync(Supplier, Executor)

newIncompleteCffu

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

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

In general, should not use this method in biz code, prefer below factory methods of Cffu:

1. runAsync(Runnable)
2. supplyAsync(Supplier, Executor)

See Also:

• runAsync(Runnable)
• runAsync(Runnable, Executor)
• supplyAsync(Supplier)
• supplyAsync(Supplier, Executor)
• CompletableFuture()

asCffu

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

Wrap an existed CompletableFuture/CompletionStage/Cffu to Cffu. for CompletableFuture class instances, Cffu.cffuUnwrap() is the inverse operation to this method.

NOTE, keep input stage unchanged if possible when wrap:

1. if input stage is a Cffu, re-wrapped with the config of this CffuFactory from CffuFactoryBuilder by Cffu.resetCffuFactory(CffuFactory).
2. if input stage is a CompletableFuture, wrap it by setting it as the underneath cf of returned cffu.
3. otherwise use input stage.toCompletableFuture as the underneath cf of returned cffu.

See Also:

• Cffu.cffuUnwrap()
• Cffu.resetCffuFactory(CffuFactory)
• asCffuArray(CompletionStage[])
• CompletionStage.toCompletableFuture()

asCffuArray

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

A convenient util method for wrap input CompletableFuture/CompletionStage/Cffu array element by asCffu(CompletionStage).

See Also:

• asCffu(CompletionStage)

allOf

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

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

if you need the results of given Cffus, prefer below methods:

1. cffuAllOf(Cffu[])
2. cffuCombine(Cffu, Cffu)/cffuCombine(Cffu, Cffu, Cffu, Cffu, Cffu) (provided overloaded methods with 2~5 input)

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

Parameters:

cfs - the Cffus

Returns:

a new Cffu that is completed when all the given Cffus complete

Throws:

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

See Also:

• cffuAllOf(Cffu[])
• cffuCombine(Cffu, Cffu)
• cffuCombine(Cffu, Cffu, Cffu)
• cffuCombine(Cffu, Cffu, Cffu, Cffu)
• cffuCombine(Cffu, Cffu, Cffu, Cffu, Cffu)
• CompletableFuture.allOf(CompletableFuture[])

allOf

@Contract(pure=true)
public Cffu<Void> allOf(CompletableFuture<?>... cfs)

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

Same as allOf(Cffu[]) with overloaded argument type CompletableFuture.

if you need the results of given CompletableFutures, prefer below methods:

1. cffuAllOf(CompletableFuture[])
2. cffuCombine(CompletableFuture, CompletableFuture)/cffuCombine(CompletableFuture, CompletableFuture, CompletableFuture, CompletableFuture, CompletableFuture) (provided overloaded methods with 2~5 input)

Parameters:

cfs - the CompletableFutures

Returns:

a new Cffu that is completed when all the given CompletableFutures complete

Throws:

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

See Also:

• allOf(Cffu[])
• cffuAllOf(CompletableFuture[])
• cffuCombine(CompletableFuture, CompletableFuture)
• cffuCombine(CompletableFuture, CompletableFuture, CompletableFuture)
• cffuCombine(CompletableFuture, CompletableFuture, CompletableFuture, CompletableFuture)
• cffuCombine(CompletableFuture, CompletableFuture, CompletableFuture, CompletableFuture, CompletableFuture)
• CompletableFuture.allOf(CompletableFuture[])

allOf

@Contract(pure=true)
public Cffu<Void> allOf()

Provided this overloaded method just for resolving "allOf is ambiguous" problem when call allOf with empty arguments: cffuFactory.allOf().

See Also:

• allOf(Cffu[])
• allOf(CompletableFuture[])

allOfFastFail

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

Returns a new Cffu that success when all the given Cffus success, the results(Cffu<Void>) of the given Cffus are not reflected in the returned Cffu, but may be obtained by inspecting them individually. If any of the given Cffus complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given Cffus, with a CompletionException holding this exception as its cause. If no Cffus are provided, returns a Cffu completed with the value null.

Parameters:

cfs - the Cffus

Returns:

a new Cffu that success when all the given Cffus success

Throws:

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

See Also:

• CompletableFutureUtils.allOfFastFail(CompletableFuture[])

allOfFastFail

@Contract(pure=true)
public Cffu<Void> allOfFastFail(CompletableFuture<?>... cfs)

Returns a new Cffu that success when all the given CompletableFutures success, the results(Cffu<Void>) of the given CompletableFutures are not reflected in the returned Cffu, but may be obtained by inspecting them individually. If any of the given CompletableFutures complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletableFutures, with a CompletionException holding this exception as its cause. If no CompletableFutures are provided, returns a Cffu completed with the value null.

Same as allOfFastFail(Cffu[]) with overloaded argument type CompletableFuture.

Parameters:

cfs - the CompletableFutures

Returns:

a new Cffu that success when all the given CompletableFutures success

Throws:

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

See Also:

• allOfFastFail(Cffu[])
• cffuAllOfFastFail(CompletableFuture[])
• CompletableFutureUtils.allOfFastFail(CompletableFuture[])

allOfFastFail

@Contract(pure=true)
public Cffu<Void> allOfFastFail()

Provided this overloaded method just for resolving "allOfFastFail is ambiguous" problem when call allOfFastFail with empty arguments: cffuFactory.allOfFastFail().

See Also:

• allOfFastFail(Cffu[])
• allOfFastFail(CompletableFuture[])

anyOf

@Contract(pure=true)
public Cffu<Object> anyOf(Cffu<?>... cfs)

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

prefer cffuAnyOf(Cffu[]) method if the given Cffus have same result type, because cffuAnyOf(Cffu[]) return type T instead of type Object, more type safe.

Parameters:

cfs - the Cffus

Returns:

a new Cffu that is completed with the result or exception from any of the given Cffus when one completes

Throws:

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

See Also:

• cffuAnyOf(Cffu[])
• CompletableFuture.anyOf(CompletableFuture[])

anyOf

@Contract(pure=true)
public Cffu<Object> anyOf(CompletableFuture<?>... cfs)

Same as anyOf(Cffu[]) with overloaded argument type CompletableFuture.

prefer cffuAnyOf(CompletableFuture[]) method if the given Cffus have same result type, because cffuAnyOf(CompletableFuture[]) return type T instead of type Object, more type safe.

Parameters:

cfs - the CompletableFutures

Returns:

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

Throws:

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

See Also:

• cffuAnyOf(CompletableFuture[])
• anyOf(Cffu[])
• CompletableFuture.anyOf(CompletableFuture[])

anyOf

@Contract(pure=true)
public Cffu<Object> anyOf()

Provided this overloaded method just for resolving "anyOf is ambiguous" problem when call anyOf with empty arguments: cffuFactory.anyOf().

See Also:

• anyOf(Cffu[])
• anyOf(CompletableFuture[])

anyOfSuccess

public Cffu<Object> anyOfSuccess(Cffu<?>... cfs)

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

Parameters:

cfs - the Cffus

Returns:

a new Cffu

Throws:

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

See Also:

• cffuAnyOf(Cffu[])

anyOfSuccess

public Cffu<Object> anyOfSuccess(CompletableFuture<?>... cfs)

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

Parameters:

cfs - the CompletableFutures

Returns:

a new Cffu

Throws:

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

See Also:

• cffuAnyOfSuccess(Cffu[])
• cffuAnyOf(Cffu[])

anyOfSuccess

public Cffu<Object> anyOfSuccess()

Provided this overloaded method just for resolving "cffuAnyOfSuccess is ambiguous" problem when call anyOfSuccess with empty arguments: cffuFactory.anyOfSuccess().

See Also:

• cffuAnyOfSuccess(Cffu[])
• cffuAnyOfSuccess(CompletableFuture[])

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

cffuAllOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> cffuAllOf(Cffu<T>... cfs)

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

Same to allOf(Cffu[]), but the returned Cffu contains the results of input Cffus.

Parameters:

cfs - the Cffus

Returns:

a new Cffu that is completed when all the given Cffus complete

Throws:

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

See Also:

• allOf(Cffu[])

cffuAllOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> cffuAllOf(CompletableFuture<T>... cfs)

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

Same as cffuAllOf(Cffu[]) with overloaded argument type CompletableFuture.

Parameters:

cfs - the CompletableFutures

Returns:

a new Cffu that is completed when all the given CompletableFutures complete

Throws:

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

See Also:

• cffuAllOf(Cffu[])

cffuAllOf

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

Provided this overloaded method just for resolving "cffuAllOf is ambiguous" problem when call cffuAllOf with empty arguments: cffuFactory.cffuAllOf().

See Also:

• cffuAllOf(Cffu[])
• cffuAllOf(CompletableFuture[])

cffuAllOfFastFail

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> cffuAllOfFastFail(Cffu<T>... cfs)

Returns a new Cffu with the results of all the given Cffus, the new Cffu success when all the given Cffus success. If any of the given Cffus complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given Cffus, with a CompletionException holding this exception as its cause. If no CompletableFutures are provided, returns a Cffu completed with the value emptyList.

Parameters:

cfs - the CompletableFutures

Returns:

a new CompletableFuture that success when all the given CompletableFutures success

Throws:

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

See Also:

• CompletableFutureUtils.allOfFastFail(CompletableFuture[])
• cffuAllOfFastFail(Cffu[])

cffuAllOfFastFail

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<List<T>> cffuAllOfFastFail(CompletableFuture<T>... cfs)

Returns a new Cffu with the results of all the given CompletableFutures, the new Cffu success when all the given CompletableFutures success. If any of the given CompletableFutures complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletableFutures, with a CompletionException holding this exception as its cause. If no CompletableFutures are provided, returns a Cffu completed with the value emptyList.

Same as cffuAllOfFastFail(Cffu[]) with overloaded argument type CompletableFuture.

Parameters:

cfs - the CompletableFutures

Returns:

a new CompletableFuture that success when all the given CompletableFutures success

Throws:

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

See Also:

• CompletableFutureUtils.allOfFastFail(CompletableFuture[])
• cffuAllOfFastFail(Cffu[])

cffuAllOfFastFail

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

Provided this overloaded method just for resolving "cffuAllOfFastFail is ambiguous" problem when call cffuAllOfFastFail with empty arguments: cffuFactory.cffuAllOfFastFail().

See Also:

• cffuAllOfFastFail(Cffu[])
• cffuAllOfFastFail(CompletableFuture[])

cffuAnyOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<T> cffuAnyOf(Cffu<T>... cfs)

Returns a new Cffu that is completed when any of the given Cffus complete, with the same result.

Same as anyOf(Cffu[]), but return result type is specified type instead of type Object.

Parameters:

cfs - the Cffus

Returns:

a new Cffu that is completed with the result or exception from any of the given Cffus when one completes

Throws:

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

See Also:

• anyOf(Cffu[])

cffuAnyOf

@Contract(pure=true)
@SafeVarargs
public final <T> Cffu<T> cffuAnyOf(CompletableFuture<T>... cfs)

Returns a new Cffu that is completed when any of the given CompletableFutures complete, with the same result.

Same as cffuAllOf(Cffu[]) with overloaded argument type CompletableFuture.

Parameters:

cfs - the CompletableFutures

Returns:

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

Throws:

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

See Also:

• cffuAnyOf(Cffu[])

cffuAnyOf

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

Provided this overloaded method just for resolving "cffuAnyOf is ambiguous" problem when call cffuAnyOf with empty arguments: cffuFactory.cffuAnyOf().

See Also:

• cffuAnyOf(Cffu[])
• cffuAnyOf(CompletableFuture[])

cffuAnyOfSuccess

@SafeVarargs
public final <T> Cffu<T> cffuAnyOfSuccess(Cffu<T>... cfs)

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

Parameters:

cfs - the Cffus

Returns:

a new Cffu

Throws:

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

See Also:

• cffuAnyOf(Cffu[])

cffuAnyOfSuccess

@SafeVarargs
public final <T> Cffu<T> cffuAnyOfSuccess(CompletableFuture<T>... cfs)

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

Same as cffuAnyOfSuccess(Cffu[]) with overloaded argument type CompletableFuture.

Parameters:

cfs - the CompletableFutures

Returns:

a new Cffu

Throws:

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

See Also:

• cffuAnyOfSuccess(Cffu[])
• cffuAnyOf(Cffu[])

cffuAnyOfSuccess

public <T> Cffu<T> cffuAnyOfSuccess()

Provided this overloaded method just for resolving "cffuAnyOfSuccess is ambiguous" problem when call cffuAnyOfSuccess with empty arguments: cffuFactory.cffuAnyOfSuccess().

See Also:

• cffuAnyOfSuccess(Cffu[])
• cffuAnyOfSuccess(CompletableFuture[])

cffuCombine

@Contract(pure=true)
public <T1,
T2> Cffu<Tuple2<T1,T2>> cffuCombine(Cffu<T1> cf1,
 Cffu<T2> cf2)

Returns a new Cffu that is completed when the given two Cffus complete. If any of the given Cffu complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuAllOf(Cffu[]) but with two inputs and return results as Tuple2.

Returns:

a new Cffu that is completed when the given two Cffus complete

Throws:

NullPointerException - if any input Cffus are null

See Also:

• cffuAllOf(Cffu[])

cffuCombine

@Contract(pure=true)
public <T1,
T2> Cffu<Tuple2<T1,T2>> cffuCombine(CompletableFuture<T1> cf1,
 CompletableFuture<T2> cf2)

Returns a new Cffu that is completed when the given two CompletableFutures complete. If any of the given CompletableFutures complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuCombine(Cffu, Cffu) with overloaded argument type CompletableFuture.

Returns:

a new Cffu that is completed when the given 2 CompletableFutures complete

Throws:

NullPointerException - if any of the given CompletableFutures are null

See Also:

• cffuCombine(Cffu, Cffu)
• cffuAllOf(CompletableFuture[])

cffuCombine

@Contract(pure=true)
public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> cffuCombine(Cffu<T1> cf1,
 Cffu<T2> cf2,
 Cffu<T3> cf3)

Returns a new Cffu that is completed when the given three Cffus complete. If any of the given Cffu complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuAllOf(Cffu[]) but with three inputs and return results as Tuple3.

Returns:

a new Cffu that is completed when the given three Cffus complete

Throws:

NullPointerException - if any input Cffus are null

See Also:

• cffuAllOf(Cffu[])

cffuCombine

@Contract(pure=true)
public <T1,
T2,
T3> Cffu<Tuple3<T1,T2,T3>> cffuCombine(CompletableFuture<T1> cf1,
 CompletableFuture<T2> cf2,
 CompletableFuture<T3> cf3)

Returns a new Cffu that is completed when the given three CompletableFutures complete. If any of the given CompletableFutures complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuCombine(Cffu, Cffu, Cffu) with overloaded argument type CompletableFuture.

Returns:

a new Cffu that is completed when the given 3 CompletableFutures complete

Throws:

NullPointerException - if any of the given CompletableFutures are null

See Also:

• cffuCombine(Cffu, Cffu, Cffu)
• cffuAllOf(CompletableFuture[])

cffuCombine

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

Returns a new Cffu that is completed when the given 4 Cffus complete. If any of the given Cffu complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuAllOf(Cffu[]) but with 4 inputs and return results as Tuple4.

Returns:

a new Cffu that is completed when the given 4 Cffus complete

Throws:

NullPointerException - if any input Cffus are null

See Also:

• cffuAllOf(Cffu[])

cffuCombine

@Contract(pure=true)
public <T1,
T2,
T3,
T4> Cffu<Tuple4<T1,T2,T3,T4>> cffuCombine(CompletableFuture<T1> cf1,
 CompletableFuture<T2> cf2,
 CompletableFuture<T3> cf3,
 CompletableFuture<T4> cf4)

Returns a new Cffu that is completed when the given 4 CompletableFutures complete. If any of the given CompletableFutures complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuCombine(Cffu, Cffu, Cffu, Cffu) with overloaded argument type CompletableFuture.

Returns:

a new Cffu that is completed when the given 4 CompletableFutures complete

Throws:

NullPointerException - if any of the given CompletableFutures are null

See Also:

• cffuCombine(Cffu, Cffu, Cffu, Cffu)
• cffuAllOf(CompletableFuture[])

cffuCombine

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

Returns a new Cffu that is completed when the given 5 Cffus complete. If any of the given Cffu complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuAllOf(Cffu[]) but with 5 inputs and return results as Tuple5.

Returns:

a new Cffu that is completed when the given 5 Cffus complete

Throws:

NullPointerException - if any input Cffus are null

See Also:

• cffuAllOf(Cffu[])

cffuCombine

@Contract(pure=true)
public <T1,
T2,
T3,
T4,
T5>
Cffu<Tuple5<T1,T2,T3,T4,T5>> cffuCombine(CompletableFuture<T1> cf1,
 CompletableFuture<T2> cf2,
 CompletableFuture<T3> cf3,
 CompletableFuture<T4> cf4,
 CompletableFuture<T5> cf5)

Returns a new Cffu that is completed when the given 5 CompletableFutures complete. If any of the given CompletableFutures complete exceptionally, then the returned Cffu also does so, with a CompletionException holding this exception as its cause.

Same as cffuCombine(Cffu, Cffu, Cffu, Cffu, Cffu) with overloaded argument type CompletableFuture.

Returns:

a new Cffu that is completed when the given 5 CompletableFutures complete

Throws:

NullPointerException - if any of the given CompletableFutures are null

See Also:

• cffuCombine(Cffu, Cffu, Cffu, Cffu, Cffu)
• cffuAllOf(CompletableFuture[])

toCompletableFutureArray

@Contract(pure=true)
@SafeVarargs
public static <T> CompletableFuture<T>[] toCompletableFutureArray(CompletionStage<T>... stages)

A convenient util method for converting input Cffu/CompletableFuture/CompletionStage array element by Cffu.toCompletableFuture()/CompletableFuture.toCompletableFuture()/CompletionStage.toCompletableFuture().

See Also:

• Cffu.toCompletableFuture()
• CompletableFuture.toCompletableFuture()
• CompletionStage.toCompletableFuture()
• asCffuArray(CompletionStage[])

cffuArrayUnwrap

@Contract(pure=true)
@SafeVarargs
public static <T> CompletableFuture<T>[] cffuArrayUnwrap(Cffu<T>... cfs)

A convenient util method for unwrap input Cffu array elements by Cffu.cffuUnwrap().

Parameters:

cfs - the Cffus

See Also:

• Cffu.cffuUnwrap()

cffuListToArray

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

Convert Cffu list to Cffu array.

completableFutureListToArray

@Contract(pure=true)
public static <T> CompletableFuture<T>[] completableFutureListToArray(List<CompletableFuture<T>> cfList)

Convert CompletableFuture list to CompletableFuture array.

defaultExecutor

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

Returns defaultExecutor.

Returns:

the default executor

See Also:

• Cffu.defaultExecutor()
• CffuFactoryBuilder.newCffuFactoryBuilder(Executor)

forbidObtrudeMethods

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

Returns forbidObtrudeMethods or not.

See Also:

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