Class Cffu<T>

java.lang.Object
io.foldright.cffu.Cffu<T>
All Implemented Interfaces:
CompletionStage<T>, Future<T>

public final class Cffu<T> extends Object implements Future<T>, CompletionStage<T>
This class Cffu is the equivalent class to CompletableFuture, contains the equivalent instance methods of CompletionStage and CompletableFuture.

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

Author:
Jerry Lee (oldratlee at gmail dot com), HuHao (995483610 at qq dot com)
See Also:
  • Method Details

    • thenApply

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAccept`") public <U> Cffu<U> thenApply(Function<? super T,? extends U> fn)
      Returns a new Cffu that, when this stage completes normally, is executed with this stage's result as the argument to the supplied function.

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

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenApply in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      fn - the function to use to compute the value of the returned Cffu
    • thenApplyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptAsync`") public <U> Cffu<U> thenApplyAsync(Function<? super T,? extends U> fn)
      Returns a new Cffu that, when this stage completes normally, is executed using defaultExecutor(), with this stage's result as the argument to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenApplyAsync in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      fn - the function to use to compute the value of the returned Cffu
    • thenApplyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptAsync`") public <U> Cffu<U> thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
      Returns a new Cffu that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenApplyAsync in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      fn - the function to use to compute the value of the returned Cffu
      executor - the executor to use for asynchronous execution
    • thenAccept

      public Cffu<Void> thenAccept(Consumer<? super T> action)
      Returns a new Cffu that, when this stage completes normally, is executed with this stage's result as the argument to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenAccept in interface CompletionStage<T>
      Parameters:
      action - the action to perform before completing the returned Cffu
    • thenAcceptAsync

      public Cffu<Void> thenAcceptAsync(Consumer<? super T> action)
      Returns a new Cffu that, when this stage completes normally, is executed using defaultExecutor(), with this stage's result as the argument to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenAcceptAsync in interface CompletionStage<T>
      Parameters:
      action - the action to perform before completing the returned Cffu
    • thenAcceptAsync

      public Cffu<Void> thenAcceptAsync(Consumer<? super T> action, Executor executor)
      Returns a new Cffu that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenAcceptAsync in interface CompletionStage<T>
      Parameters:
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • thenRun

      public Cffu<Void> thenRun(Runnable action)
      Returns a new Cffu that, when this stage completes normally, executes the given action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenRun in interface CompletionStage<T>
      Parameters:
      action - the action to perform before completing the returned Cffu
    • thenRunAsync

      public Cffu<Void> thenRunAsync(Runnable action)
      Returns a new Cffu that, when this stage completes normally, executes the given action using defaultExecutor().

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenRunAsync in interface CompletionStage<T>
      Parameters:
      action - the action to perform before completing the returned Cffu
    • thenRunAsync

      public Cffu<Void> thenRunAsync(Runnable action, Executor executor)
      Returns a new Cffu that, when this stage completes normally, executes the given action using the supplied Executor.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenRunAsync in interface CompletionStage<T>
      Parameters:
      action - the action to perform before completing the returned Cffu
    • thenMApplyFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyFailFastAsync(Function<? super T,? extends U>... fns)
      Shortcut to method allResultsFailFastOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of functions.

      See the allResultsFailFastOf documentation for the rules of result computation.

    • thenMApplyFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyFailFastAsync(Executor executor, Function<? super T,? extends U>... fns)
      Shortcut to method allResultsFailFastOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of functions.

      See the allResultsFailFastOf documentation for the rules of result computation.

      NOTE: if the executor argument is passed by lambda, the Runnable lambda parameter type need be declared to avoid the compilation error, more info see the demo code
      demo code

    • thenMApplyAllSuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyAllSuccessAsync(@Nullable U valueIfFailed, Function<? super T,? extends U>... fns)
      Shortcut to method allSuccessResultsOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of functions.

      See the allSuccessResultsOf documentation for the rules of result computation.

    • thenMApplyAllSuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyAllSuccessAsync(Executor executor, @Nullable U valueIfFailed, Function<? super T,? extends U>... fns)
      Shortcut to method allSuccessResultsOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of functions.

      See the allSuccessResultsOf documentation for the rules of result computation.

      NOTE: if the executor argument is passed by lambda, the Runnable lambda parameter type need be declared to avoid the compilation error, more info see the demo code
      demo code

    • thenMApplyMostSuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyMostSuccessAsync(@Nullable U valueIfNotSuccess, long timeout, TimeUnit unit, Function<? super T,? extends U>... fns)
      Shortcut to method mostSuccessResultsOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of functions.

      See the mostSuccessResultsOf documentation for the rules of result computation.

    • thenMApplyMostSuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyMostSuccessAsync(Executor executor, @Nullable U valueIfNotSuccess, long timeout, TimeUnit unit, Function<? super T,? extends U>... fns)
      Shortcut to method mostSuccessResultsOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of functions.

      See the mostSuccessResultsOf documentation for the rules of result computation.

    • thenMApplyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyAsync(Function<? super T,? extends U>... fns)
      Shortcut to method allResultsOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of functions.

      See the allResultsOf documentation for the rules of result computation.

    • thenMApplyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<List<U>> thenMApplyAsync(Executor executor, Function<? super T,? extends U>... fns)
      Shortcut to method allResultsOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of functions.

      See the allResultsOf documentation for the rules of result computation.

      NOTE: if the executor argument is passed by lambda, the Runnable lambda parameter type need be declared to avoid the compilation error, more info see the demo code
      demo code

    • thenMApplyAnySuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<U> thenMApplyAnySuccessAsync(Function<? super T,? extends U>... fns)
      Shortcut to method anySuccessOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of functions.

      See the anySuccessOf documentation for the rules of result computation.

    • thenMApplyAnySuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<U> thenMApplyAnySuccessAsync(Executor executor, Function<? super T,? extends U>... fns)
      Shortcut to method anySuccessOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of functions.

      See the anySuccessOf documentation for the rules of result computation.

      NOTE: if the executor argument is passed by lambda, the Runnable lambda parameter type need be declared to avoid the compilation error, more info see the demo code
      demo code

    • thenMApplyAnyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<U> thenMApplyAnyAsync(Function<? super T,? extends U>... fns)
      Shortcut to method anyOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of functions.

      See the anyOf documentation for the rules of result computation.

    • thenMApplyAnyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final <U> Cffu<U> thenMApplyAnyAsync(Executor executor, Function<? super T,? extends U>... fns)
      Shortcut to method anyOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of functions.

      See the anyOf documentation for the rules of result computation.

      NOTE: if the executor argument is passed by lambda, the Runnable lambda parameter type need be declared to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final Cffu<Void> thenMAcceptFailFastAsync(Consumer<? super T>... actions)
      Shortcut to method allFailFastOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of actions.

      See the allFailFastOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final Cffu<Void> thenMAcceptFailFastAsync(Executor executor, Consumer<? super T>... actions)
      Shortcut to method allFailFastOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of actions.

      See the allFailFastOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptAsync

      @SafeVarargs public final Cffu<Void> thenMAcceptAsync(Consumer<? super T>... actions)
      Shortcut to method allOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of actions.

      See the allOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptAsync

      @SafeVarargs public final Cffu<Void> thenMAcceptAsync(Executor executor, Consumer<? super T>... actions)
      Shortcut to method allOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of actions.

      See the allOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptAnySuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final Cffu<Void> thenMAcceptAnySuccessAsync(Consumer<? super T>... actions)
      Shortcut to method anySuccessOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of actions.

      See the anySuccessOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptAnySuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final Cffu<Void> thenMAcceptAnySuccessAsync(Executor executor, Consumer<? super T>... actions)
      Shortcut to method anySuccessOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of actions.

      See the anySuccessOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptAnyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final Cffu<Void> thenMAcceptAnyAsync(Consumer<? super T>... actions)
      Shortcut to method anyOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier); The given stage's result is used as the argument of actions.

      See the anyOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMAcceptAnyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") @SafeVarargs public final Cffu<Void> thenMAcceptAnyAsync(Executor executor, Consumer<? super T>... actions)
      Shortcut to method anyOf, wraps input functions to Cffu by CffuFactory.supplyAsync(Supplier, Executor); The given stage's result is used as the argument of actions.

      See the anyOf documentation for the rules of result computation.

      NOTE: if the first argument is passed by lambda, need declare the lambda parameter type to avoid the compilation error, more info see the demo code
      demo code

    • thenMRunFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMRunAsync`") public Cffu<Void> thenMRunFailFastAsync(Runnable... actions)
      Shortcut to method allFailFastOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable).

      See the allFailFastOf documentation for the rules of result computation.

    • thenMRunFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMRunAsync`") public Cffu<Void> thenMRunFailFastAsync(Executor executor, Runnable... actions)
      Shortcut to method allFailFastOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable, Executor).

      See the allFailFastOf documentation for the rules of result computation.

    • thenMRunAsync

      public Cffu<Void> thenMRunAsync(Runnable... actions)
      Shortcut to method allOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable).

      See the allOf documentation for the rules of result computation.

    • thenMRunAsync

      public Cffu<Void> thenMRunAsync(Executor executor, Runnable... actions)
      Shortcut to method allOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable, Executor).

      See the allOf documentation for the rules of result computation.

    • thenMRunAnySuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMRunAsync`") public Cffu<Void> thenMRunAnySuccessAsync(Runnable... actions)
      Shortcut to method anySuccessOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable).

      See the anySuccessOf documentation for the rules of result computation.

    • thenMRunAnySuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMRunAsync`") public Cffu<Void> thenMRunAnySuccessAsync(Executor executor, Runnable... actions)
      Shortcut to method anySuccessOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable, Executor).

      See the anySuccessOf documentation for the rules of result computation.

    • thenMRunAnyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMRunAsync`") public Cffu<Void> thenMRunAnyAsync(Runnable... actions)
      Shortcut to method anyOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable).

      See the anyOf documentation for the rules of result computation.

    • thenMRunAnyAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMRunAsync`") public Cffu<Void> thenMRunAnyAsync(Executor executor, Runnable... actions)
      Shortcut to method anyOf, wraps input actions to Cffu by CffuFactory.runAsync(Runnable, Executor).

      See the anyOf documentation for the rules of result computation.

    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyTupleFailFastAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyTupleFailFastAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyTupleFailFastAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyTupleFailFastAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyTupleFailFastAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyTupleFailFastAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyTupleFailFastAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
    • thenMApplyTupleFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyTupleFailFastAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyAllSuccessTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
      Tuple variant of thenMApplyAllSuccessAsync(Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyAllSuccessTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
      Tuple variant of thenMApplyAllSuccessAsync(Executor, Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyAllSuccessTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
      Tuple variant of thenMApplyAllSuccessAsync(Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyAllSuccessTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
      Tuple variant of thenMApplyAllSuccessAsync(Executor, Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyAllSuccessTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
      Tuple variant of thenMApplyAllSuccessAsync(Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyAllSuccessTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
      Tuple variant of thenMApplyAllSuccessAsync(Executor, Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyAllSuccessTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
      Tuple variant of thenMApplyAllSuccessAsync(Object, Function[]) with null valueIfFailed.

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

    • thenMApplyAllSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyAllSuccessTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
      Tuple variant of thenMApplyAllSuccessAsync(Executor, Object, Function[]) with null valueIfFailed.

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

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
      Tuple variant of thenMApplyMostSuccessAsync(Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
      Tuple variant of thenMApplyMostSuccessAsync(Executor, Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
      Tuple variant of thenMApplyMostSuccessAsync(Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
      Tuple variant of thenMApplyMostSuccessAsync(Executor, Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
      Tuple variant of thenMApplyMostSuccessAsync(Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
      Tuple variant of thenMApplyMostSuccessAsync(Executor, Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyMostSuccessTupleAsync(long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
      Tuple variant of thenMApplyMostSuccessAsync(Object, long, TimeUnit, Function[]) 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).

    • thenMApplyMostSuccessTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyMostSuccessTupleAsync(Executor executor, long timeout, TimeUnit unit, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
      Tuple variant of thenMApplyMostSuccessAsync(Executor, Object, long, TimeUnit, Function[]) 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).

    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
      Tuple variant of thenMApplyAsync(Function[]).
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2> Cffu<Tuple2<U1,U2>> thenMApplyTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2)
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
      Tuple variant of thenMApplyAsync(Function[]).
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3> Cffu<Tuple3<U1,U2,U3>> thenMApplyTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3)
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
      Tuple variant of thenMApplyAsync(Function[]).
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4> Cffu<Tuple4<U1,U2,U3,U4>> thenMApplyTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4)
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyTupleAsync(Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
      Tuple variant of thenMApplyAsync(Function[]).
    • thenMApplyTupleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer simple method `thenMAcceptAsync`") public <U1, U2, U3, U4, U5> Cffu<Tuple5<U1,U2,U3,U4,U5>> thenMApplyTupleAsync(Executor executor, Function<? super T,? extends U1> fn1, Function<? super T,? extends U2> fn2, Function<? super T,? extends U3> fn3, Function<? super T,? extends U4> fn4, Function<? super T,? extends U5> fn5)
    • thenCombineFailFast

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothFailFast`") public <U, V> Cffu<V> thenCombineFailFast(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Type Parameters:
      U - the type of the other CompletionStage's result
      V - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • thenCombineFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothFailFastAsync`") public <U, V> Cffu<V> thenCombineFailFastAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied function. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Type Parameters:
      U - the type of the other CompletionStage's result
      V - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • thenCombineFailFastAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothFailFastAsync`") public <U, V> Cffu<V> thenCombineFailFastAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied function. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Type Parameters:
      U - the type of the other CompletionStage's result
      V - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
      executor - the executor to use for asynchronous execution
    • thenAcceptBothFailFast

      public <U> Cffu<Void> thenAcceptBothFailFast(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Type Parameters:
      U - the type of the other CompletionStage's result
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • thenAcceptBothFailFastAsync

      public <U> Cffu<Void> thenAcceptBothFailFastAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Type Parameters:
      U - the type of the other CompletionStage's result
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • thenAcceptBothFailFastAsync

      public <U> Cffu<Void> thenAcceptBothFailFastAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Type Parameters:
      U - the type of the other CompletionStage's result
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • runAfterBothFailFast

      public Cffu<Void> runAfterBothFailFast(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterBothFailFastAsync

      public Cffu<Void> runAfterBothFailFastAsync(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using defaultExecutor(). if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterBothFailFastAsync

      public Cffu<Void> runAfterBothFailFastAsync(CompletionStage<?> other, Runnable action, Executor executor)
      Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using the supplied executor. if any of the given stage complete exceptionally, then the returned Cffu also does so *without* waiting other incomplete given CompletionStage, with a CompletionException holding this exception as its cause.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • thenCombine

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBoth`") public <U, V> Cffu<V> thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenCombine in interface CompletionStage<T>
      Type Parameters:
      U - the type of the other CompletionStage's result
      V - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • thenCombineAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothAsync`") public <U, V> Cffu<V> thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenCombineAsync in interface CompletionStage<T>
      Type Parameters:
      U - the type of the other CompletionStage's result
      V - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • thenCombineAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `thenAcceptBothAsync`") public <U, V> Cffu<V> thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenCombineAsync in interface CompletionStage<T>
      Type Parameters:
      U - the type of the other CompletionStage's result
      V - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
      executor - the executor to use for asynchronous execution
    • thenAcceptBoth

      public <U> Cffu<Void> thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenAcceptBoth in interface CompletionStage<T>
      Type Parameters:
      U - the type of the other CompletionStage's result
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • thenAcceptBothAsync

      public <U> Cffu<Void> thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using defaultExecutor(), with the two results as arguments to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenAcceptBothAsync in interface CompletionStage<T>
      Type Parameters:
      U - the type of the other CompletionStage's result
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • thenAcceptBothAsync

      public <U> Cffu<Void> thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
      Returns a new Cffu that, when this and the other given stage both complete normally, is executed using the supplied executor, with the two results as arguments to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenAcceptBothAsync in interface CompletionStage<T>
      Type Parameters:
      U - the type of the other CompletionStage's result
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • runAfterBoth

      public Cffu<Void> runAfterBoth(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      runAfterBoth in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterBothAsync

      public Cffu<Void> runAfterBothAsync(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using defaultExecutor().

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      runAfterBothAsync in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterBothAsync

      public Cffu<Void> runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
      Returns a new Cffu that, when this and the other given stage both complete normally, executes the given action using the supplied executor.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      runAfterBothAsync in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • applyToEitherSuccess

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherSuccess`") public <U> Cffu<U> applyToEitherSuccess(CompletionStage<? extends T> other, Function<? super T,U> fn)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.
      Type Parameters:
      U - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • applyToEitherSuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherSuccessAsync`") public <U> Cffu<U> applyToEitherSuccessAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied function.
      Type Parameters:
      U - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • applyToEitherSuccessAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherSuccessAsync`") public <U> Cffu<U> applyToEitherSuccessAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied function.
      Type Parameters:
      U - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
      executor - the executor to use for asynchronous execution
    • acceptEitherSuccess

      public Cffu<Void> acceptEitherSuccess(CompletionStage<? extends T> other, Consumer<? super T> action)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • acceptEitherSuccessAsync

      public Cffu<Void> acceptEitherSuccessAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied action.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • acceptEitherSuccessAsync

      public Cffu<Void> acceptEitherSuccessAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied action.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • runAfterEitherSuccess

      public Cffu<Void> runAfterEitherSuccess(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action. Otherwise, all two complete exceptionally, the returned Cffu also does so, with a CompletionException holding an exception from any of as its cause.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterEitherSuccessAsync

      public Cffu<Void> runAfterEitherSuccessAsync(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using defaultExecutor(). Otherwise, all two complete exceptionally, the returned Cffu also does so, with a CompletionException holding an exception from any of as its cause.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterEitherSuccessAsync

      public Cffu<Void> runAfterEitherSuccessAsync(CompletionStage<?> other, Runnable action, Executor executor)
      Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using the supplied executor. Otherwise, all two complete exceptionally, the returned Cffu also does so, with a CompletionException holding an exception from any of as its cause.
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • applyToEither

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEither`") public <U> Cffu<U> applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      applyToEither in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • applyToEitherAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherAsync`") public <U> Cffu<U> applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      applyToEitherAsync in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
    • applyToEitherAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `acceptEitherAsync`") public <U> Cffu<U> applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied function.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      applyToEitherAsync in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      other - the other CompletionStage
      fn - the function to use to compute the value of the returned Cffu
      executor - the executor to use for asynchronous execution
    • acceptEither

      public Cffu<Void> acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      acceptEither in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • acceptEitherAsync

      public Cffu<Void> acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using defaultExecutor(), with the corresponding result as argument to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      acceptEitherAsync in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • acceptEitherAsync

      public Cffu<Void> acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
      Returns a new Cffu that, when either this or the other given stage complete normally, is executed using the supplied executor, with the corresponding result as argument to the supplied action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      acceptEitherAsync in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • runAfterEither

      public Cffu<Void> runAfterEither(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      runAfterEither in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterEitherAsync

      public Cffu<Void> runAfterEitherAsync(CompletionStage<?> other, Runnable action)
      Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using defaultExecutor().

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      runAfterEitherAsync in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
    • runAfterEitherAsync

      public Cffu<Void> runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
      Returns a new Cffu that, when either this or the other given stage complete normally, executes the given action using the supplied executor.

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      runAfterEitherAsync in interface CompletionStage<T>
      Parameters:
      other - the other CompletionStage
      action - the action to perform before completing the returned Cffu
      executor - the executor to use for asynchronous execution
    • catching

      public <X extends Throwable> Cffu<T> catching(Class<X> exceptionType, Function<? super X,? extends T> fallback)
      Returns a new Cffu that, when this Cffu completes exceptionally with the given exceptionType, is executed with the exception from this Cffu as the argument to the supplied function. Otherwise, the returned Cffu contains same result as this Cffu.

      "The exception from this Cffu" means the cause of the ExecutionException thrown by get() or, if get() throws a different kind of exception, that exception itself; aka the exception is unwrapped by CompletableFutureUtils.unwrapCfException(Throwable).

      Parameters:
      exceptionType - the exception type that triggers use of fallback. The exception type is matched against the exception from this Cffu. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoiding Throwable.class in particular.
      fallback - the Function to be called if this Cffu fails with the expected exception type. The function's argument is the exception from this Cffu.
      See Also:
    • catchingAsync

      public <X extends Throwable> Cffu<T> catchingAsync(Class<X> exceptionType, Function<? super X,? extends T> fallback)
      Returns a new Cffu that, when this Cffu completes exceptionally with the given exceptionType, is executed with the exception from this Cffu as the argument to the supplied function, using defaultExecutor(). Otherwise, the returned Cffu contains same result as this Cffu.

      "The exception from this Cffu" means the cause of the ExecutionException thrown by get() or, if get() throws a different kind of exception, that exception itself; aka the exception is unwrapped by CompletableFutureUtils.unwrapCfException(Throwable).

      Parameters:
      exceptionType - the exception type that triggers use of fallback. The exception type is matched against the exception from this Cffu. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoiding Throwable.class in particular.
      fallback - the Function to be called if this Cffu fails with the expected exception type. The function's argument is the exception from this Cffu.
      See Also:
    • catchingAsync

      public <X extends Throwable> Cffu<T> catchingAsync(Class<X> exceptionType, Function<? super X,? extends T> fallback, Executor executor)
      Returns a new Cffu that, when this Cffu completes exceptionally with the given exceptionType, is executed with the exception from this Cffu as the argument to the supplied function, using the supplied Executor. Otherwise, the returned Cffu contains same result as this Cffu.

      "The exception from this Cffu" means the cause of the ExecutionException thrown by get() or, if get() throws a different kind of exception, that exception itself; aka the exception is unwrapped by CompletableFutureUtils.unwrapCfException(Throwable).

      Parameters:
      exceptionType - the exception type that triggers use of fallback. The exception type is matched against the exception from this Cffu. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoiding Throwable.class in particular.
      fallback - the Function to be called if this Cffu fails with the expected exception type. The function's argument is the exception from this Cffu.
      executor - the executor to use for asynchronous execution
      See Also:
    • exceptionally

      public Cffu<T> exceptionally(Function<Throwable,? extends T> fn)
      Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function. Otherwise, if this stage completes normally, then the returned stage also completes normally with the same value.

      Just as catching Throwable is not best practice in general, this method handles the Throwable; Strongly recommend using catching(Class, Function) instead in your business application.

      Specified by:
      exceptionally in interface CompletionStage<T>
      Parameters:
      fn - the function to use to compute the value of the returned Cffu if this Cffu completed exceptionally
      See Also:
    • exceptionallyAsync

      public Cffu<T> exceptionallyAsync(Function<Throwable,? extends T> fn)
      Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function, using defaultExecutor(). Otherwise, if this stage completes normally, then the returned stage also completes normally with the same value.

      Just as catching Throwable is not best practice in general, this method handles the Throwable; Strongly recommend using catchingAsync(Class, Function) instead in your business application.

      Specified by:
      exceptionallyAsync in interface CompletionStage<T>
      Parameters:
      fn - the function to use to compute the value of the returned Cffu if this Cffu completed exceptionally
      See Also:
    • exceptionallyAsync

      public Cffu<T> exceptionallyAsync(Function<Throwable,? extends T> fn, Executor executor)
      Returns a new Cffu that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function, using the supplied Executor. Otherwise, if this stage completes normally, then the returned stage also completes normally with the same value.

      Just as catching Throwable is not best practice in general, this method handles the Throwable; Strongly recommend using catchingAsync(Class, Function, Executor) instead in your business application.

      Specified by:
      exceptionallyAsync in interface CompletionStage<T>
      Parameters:
      fn - the function to use to compute the value of the returned Cffu if this Cffu completed exceptionally
      executor - the executor to use for asynchronous execution
      See Also:
    • orTimeout

      public Cffu<T> orTimeout(long timeout, TimeUnit unit)
      Returns a new Cffu that is completed exceptionally with a TimeoutException when this Cffu is not completed before the given timeout; otherwise the returned Cffu completed with the same successful result or exception of this Cffu.

      Uses defaultExecutor() as executorWhenTimeout.

      CAUTION: This method returns a new Cffu instead of this Cffu to avoid the subsequent usage of the delay thread; This behavior is DIFFERENT from the original CF method CompletableFuture#orTimeout and its backport method unsafeOrTimeout. More info see the javadoc of unsafeOrTimeout and the demo DelayDysfunctionDemo.

      Parameters:
      timeout - how long to wait before completing exceptionally with a TimeoutException, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
    • unsafeOrTimeout

      @Contract("_, _ -> this") public Cffu<T> unsafeOrTimeout(long timeout, TimeUnit unit)
      Exceptionally completes this Cffu with a TimeoutException if not otherwise completed before the given timeout.

      CAUTION: This method is UNSAFE!

      When the wait timed out, the subsequent non-async actions of the dependent Cffus/CompletableFutures are performed in CompletableFuture's internal SINGLE-thread delay executor (including timeout functionality). This means that the long-running subsequent non-async actions will block this executor thread, preventing it from handling other timeouts and delays, effectively breaking CompletableFuture's timeout and delay functionality.

      Strongly recommend using the safe method orTimeout instead of this method. Using this method is appropriate only when:

      • the returned Cffu is only read explicitly(e.g. by get/join/resultNow methods), and/or
      • all subsequent actions of dependent Cffus/CompletableFutures are guaranteed to execute asynchronously (i.e., the dependent Cffus/CompletableFutures are created using async methods).
      In these cases, using this unsafe method avoids an unnecessary thread switch when timeout occurs; However, these conditions are difficult to guarantee in practice especially when the returned Cffu is used by others' codes.

      Note: Before Java 21(Java 20-), CompletableFuture#orTimeout leaks if the future completes exceptionally, more info see issue JDK-8303742, PR review openjdk/jdk/13059 and JDK bugfix commit. The cffu backport logic(for Java 20-) has merged this JDK bugfix.

      Parameters:
      timeout - how long to wait before completing exceptionally with a TimeoutException, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      this Cffu
      See Also:
    • completeOnTimeout

      public Cffu<T> completeOnTimeout(@Nullable T value, long timeout, TimeUnit unit)
      Returns a new Cffu that is completed normally with the given value when this Cffu is not completed before the given timeout; otherwise the returned Cffu completed with the same successful result or exception of this Cffu.

      Uses defaultExecutor() as executorWhenTimeout.

      CAUTION: This method returns a new Cffu instead of this Cffu to avoid the subsequent usage of the delay thread; This behavior is DIFFERENT from the original CF method CompletableFuture#completeOnTimeout and its backport method unsafeCompleteOnTimeout. More info see the javadoc of unsafeCompleteOnTimeout(T, long, java.util.concurrent.TimeUnit) and the demo DelayDysfunctionDemo.

      Parameters:
      value - the value to use upon timeout
      timeout - how long to wait before completing normally with the given value, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
    • unsafeCompleteOnTimeout

      @Contract("_, _, _ -> this") public Cffu<T> unsafeCompleteOnTimeout(@Nullable T value, long timeout, TimeUnit unit)
      Completes this Cffu with the given value if not otherwise completed before the given timeout.

      CAUTION: This method is UNSAFE!

      When the wait timed out, the subsequent non-async actions of the dependent Cffus/CompletableFutures are performed in CompletableFuture's internal SINGLE-thread delay executor (including timeout functionality). This means that the long-running subsequent non-async actions will block this executor thread, preventing it from handling other timeouts and delays, effectively breaking CompletableFuture's timeout and delay functionality.

      Strongly recommend using the safe method completeOnTimeout instead of this method. Using this method is appropriate only when:

      • the returned Cffu is only read explicitly(e.g. by get/join/resultNow methods), and/or
      • all subsequent actions of dependent Cffus/CompletableFutures are guaranteed to execute asynchronously (i.e., the dependent Cffus/CompletableFutures are created using async methods).
      In these cases, using this unsafe method avoids an unnecessary thread switch when timeout occurs; However, these conditions are difficult to guarantee in practice especially when the returned Cffu is used by others' codes.
      Parameters:
      value - the value to use upon timeout
      timeout - how long to wait before completing normally with the given value, in units of unit
      unit - a TimeUnit determining how to interpret the timeout parameter
      Returns:
      this Cffu
      See Also:
    • thenCompose

      public <U> Cffu<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
      Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function.

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

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

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

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenCompose in interface CompletionStage<T>
      Type Parameters:
      U - the type of the returned Cffu's result
      Parameters:
      fn - the function to use to compute another CompletionStage
    • thenComposeAsync

      public <U> Cffu<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
      Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function, executed using defaultExecutor().

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

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

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenComposeAsync in interface CompletionStage<T>
      Type Parameters:
      U - the type of the returned Cffu's result
      Parameters:
      fn - the function to use to compute another CompletionStage
    • thenComposeAsync

      public <U> Cffu<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
      Returns a new Cffu that is completed with the same value as the CompletionStage returned by the given function, executed using the supplied Executor.

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

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

      See the CompletionStage documentation for rules covering exceptional completion.

      Specified by:
      thenComposeAsync in interface CompletionStage<T>
      Type Parameters:
      U - the type of the returned Cffu's result
      Parameters:
      fn - the function to use to compute another CompletionStage
      executor - the executor to use for asynchronous execution
    • catchingCompose

      public <X extends Throwable> Cffu<T> catchingCompose(Class<X> exceptionType, Function<? super X,? extends CompletionStage<T>> fallback)
      Returns a new Cffu that, when this Cffu completes exceptionally with the given exceptionType, is composed using the results of the supplied function applied to the exception from this Cffu.

      "The exception from this Cffu" means the cause of the ExecutionException thrown by get() or, if get() throws a different kind of exception, that exception itself; aka the exception is unwrapped by CompletableFutureUtils.unwrapCfException(Throwable).

      Parameters:
      exceptionType - the exception type that triggers use of fallback. The exception type is matched against the exception from this Cffu. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoiding Throwable.class in particular.
      fallback - the Function to be called if this Cffu fails with the expected exception type. The function's argument is the exception from this Cffu.
      See Also:
    • catchingComposeAsync

      public <X extends Throwable> Cffu<T> catchingComposeAsync(Class<X> exceptionType, Function<? super X,? extends CompletionStage<T>> fallback)
      Returns a new Cffu that, when this Cffu completes exceptionally with the given exceptionType, is composed using the results of the supplied function applied to the exception from this Cffu using defaultExecutor().

      "The exception from this Cffu" means the cause of the ExecutionException thrown by get() or, if get() throws a different kind of exception, that exception itself; aka the exception is unwrapped by CompletableFutureUtils.unwrapCfException(Throwable).

      Parameters:
      exceptionType - the exception type that triggers use of fallback. The exception type is matched against the exception from this Cffu. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoiding Throwable.class in particular.
      fallback - the Function to be called if this Cffu fails with the expected exception type. The function's argument is the exception from this Cffu.
      See Also:
    • catchingComposeAsync

      public <X extends Throwable> Cffu<T> catchingComposeAsync(Class<X> exceptionType, Function<? super X,? extends CompletionStage<T>> fallback, Executor executor)
      Returns a new Cffu that, when this Cffu completes exceptionally with the given exceptionType, is composed using the results of the supplied function applied to the exception from this Cffu, using the supplied Executor.

      "The exception from this Cffu" means the cause of the ExecutionException thrown by get() or, if get() throws a different kind of exception, that exception itself; aka the exception is unwrapped by CompletableFutureUtils.unwrapCfException(Throwable).

      Parameters:
      exceptionType - the exception type that triggers use of fallback. The exception type is matched against the exception from this Cffu. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoiding Throwable.class in particular.
      fallback - the Function to be called if this Cffu fails with the expected exception type. The function's argument is the exception from this Cffu.
      executor - the executor to use for asynchronous execution
      See Also:
    • exceptionallyCompose

      public Cffu<T> exceptionallyCompose(Function<Throwable,? extends CompletionStage<T>> fn)
      Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception.

      Just as catching Throwable is not best practice in general, this method handles the Throwable; Strongly recommend using catchingCompose(Class, Function) instead in your business application.

      Specified by:
      exceptionallyCompose in interface CompletionStage<T>
      Parameters:
      fn - the function to use to compute the returned CompletionStage if this CompletionStage completed exceptionally
      See Also:
    • exceptionallyComposeAsync

      public Cffu<T> exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn)
      Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception, using defaultExecutor().

      Just as catching Throwable is not best practice in general, this method handles the Throwable; Strongly recommend using catchingComposeAsync(Class, Function) instead in your business application.

      Specified by:
      exceptionallyComposeAsync in interface CompletionStage<T>
      Parameters:
      fn - the function to use to compute the returned CompletionStage if this Cffu completed exceptionally
      See Also:
    • exceptionallyComposeAsync

      public Cffu<T> exceptionallyComposeAsync(Function<Throwable,? extends CompletionStage<T>> fn, Executor executor)
      Returns a new Cffu that, when this stage completes exceptionally, is composed using the results of the supplied function applied to this stage's exception, using the supplied Executor.

      Just as catching Throwable is not best practice in general, this method handles the Throwable; Strongly recommend using catchingComposeAsync(Class, Function, Executor) instead in your business application.

      Specified by:
      exceptionallyComposeAsync in interface CompletionStage<T>
      Parameters:
      fn - the function to use to compute the returned CompletionStage if this Cffu completed exceptionally
      executor - the executor to use for asynchronous execution
      See Also:
    • handle

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `peek`") public <U> Cffu<U> handle(BiFunction<? super T,Throwable,? extends U> fn)
      Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed with this cffu's result and exception as arguments to the supplied function.

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

      Specified by:
      handle in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      fn - the function to use to compute the value of the returned Cffu
    • handleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `peekAsync`") public <U> Cffu<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
      Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed using defaultExecutor(), with this cffu's result and exception as arguments to the supplied function.

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

      Specified by:
      handleAsync in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      fn - the function to use to compute the value of the returned Cffu
    • handleAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `peekAsync`") public <U> Cffu<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
      Returns a new Cffu that, when this cffu completes either normally or exceptionally, is executed using the supplied executor, with this cffu's result and exception as arguments to the supplied function.

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

      Specified by:
      handleAsync in interface CompletionStage<T>
      Type Parameters:
      U - the function's return type
      Parameters:
      fn - the function to use to compute the value of the returned cffu
      executor - the executor to use for asynchronous execution
    • whenComplete

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `peek`") public Cffu<T> whenComplete(BiConsumer<? super T,? super Throwable> action)
      Returns a new Cffu with the same result or exception as this stage, that executes the given action when this stage completes.

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

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

      Specified by:
      whenComplete in interface CompletionStage<T>
      Parameters:
      action - the action to perform
    • whenCompleteAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `peekAsync`") public Cffu<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
      Returns a new Cffu with the same result or exception as this stage, that executes the given action using defaultExecutor() when this stage completes.

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

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

      Specified by:
      whenCompleteAsync in interface CompletionStage<T>
      Parameters:
      action - the action to perform
    • whenCompleteAsync

      @CheckReturnValue(explanation="should use the returned Cffu; otherwise, prefer method `peekAsync`") public Cffu<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)
      Returns a new Cffu with the same result or exception as this stage, that executes the given action using the supplied Executor when this stage completes.

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

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

      Specified by:
      whenCompleteAsync in interface CompletionStage<T>
      Parameters:
      action - the action to perform
      executor - the executor to use for asynchronous execution
    • peek

      @Contract("_ -> this") public Cffu<T> peek(BiConsumer<? super T,? super Throwable> action)
      Peeks the result by executing the given action when this cffu completes, returns this cffu.

      When this cffu is complete, the given action is invoked with the result(or null if none) and the exception (or null if none) of this cffu as arguments.

      CAUTION: The return cffu of method whenComplete(BiConsumer) will contain DIFFERENT result to this cffu when this cffu completed normally but the supplied action throws an exception. This behavior of method whenComplete is subtle, and common misused if you just want to peek this cffu without affecting the result(e.g. logging the cf result).
      For this peek method, whether the supplied action throws an exception or not, the result of return cffu(aka. this cffu) is NOT affected.

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

      Parameters:
      action - the action to perform
      Returns:
      this Cffu
      See Also:
    • peekAsync

      @Contract("_ -> this") public Cffu<T> peekAsync(BiConsumer<? super T,? super Throwable> action)
      Peeks the result by executing the given action using defaultExecutor() when this cffu completes, returns this cffu.

      When this cffu is complete, the given action is invoked with the result(or null if none) and the exception (or null if none) of this cffu as arguments.

      CAUTION: The return cffu of method whenCompleteAsync(BiConsumer) will contain DIFFERENT result to this cffu when this cffu completed normally but the supplied action throws an exception. This behavior of method whenComplete is subtle, and common misused if you just want to peek this cffu without affecting the result(e.g. logging the cf result).
      For this peek method, whether the supplied action throws an exception or not, the result of return cffu(aka. this cffu) is NOT affected.

      Unlike method handleAsync(BiFunction) and like method whenCompleteAsync(BiConsumer), this method is not designed to translate completion outcomes.

      Parameters:
      action - the action to perform
      Returns:
      this Cffu
      See Also:
    • peekAsync

      @Contract("_, _ -> this") public Cffu<T> peekAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)
      Peeks the result by executing the given action using the supplied executor when this cffu completes, returns this cffu.

      When this cffu is complete, the given action is invoked with the result(or null if none) and the exception (or null if none) of this cffu as arguments.

      CAUTION: The return cffu of method whenCompleteAsync(BiConsumer, Executor) will contain DIFFERENT result to this cffu when this cffu completed normally but the supplied action throws an exception. This behavior of method whenComplete is subtle, and common misused if you just want to peek this cffu without affecting the result(e.g. logging the cf result).
      For this peek method, whether the supplied action throws an exception or not, the result of return cffu(aka. this cffu) is NOT affected.

      Unlike method handleAsync(BiFunction, Executor) and like method whenCompleteAsync(BiConsumer, Executor), this method is not designed to translate completion outcomes.

      Parameters:
      action - the action to perform
      Returns:
      this Cffu
      See Also:
    • get

      Waits if necessary for the computation to complete, and then retrieves its result.
      Specified by:
      get in interface Future<T>
      Returns:
      the computed result
      Throws:
      CancellationException - if the computation was cancelled
      ExecutionException - if the computation threw an exception
      InterruptedException - if the current thread was interrupted while waiting
    • get

      Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
      Specified by:
      get in interface Future<T>
      Parameters:
      timeout - the maximum time to wait
      unit - the time unit of the timeout argument
      Returns:
      the computed result
      Throws:
      CancellationException - if the computation was cancelled
      ExecutionException - if the computation threw an exception
      InterruptedException - if the current thread was interrupted while waiting
      TimeoutException - if the wait timed out
    • join

      @Blocking @Nullable public T join()
      Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally.

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

      Returns:
      the result value
      Throws:
      CancellationException - if the computation was cancelled
      CompletionException - if this future completed exceptionally or a completion computation threw an exception
    • join

      @Blocking @Nullable public T join(long timeout, TimeUnit unit)
      Waits if necessary for at most the given time for the computation to complete, and then retrieves its result value when complete, or throws an (unchecked) exception if completed exceptionally.

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

      NOTE: Calling this method

      result = cffu.join(timeout, unit);

      is the same as:

      result = cffu.copy() // defensive copy to avoid writing this cffu unexpectedly
           .orTimeout(timeout, unit)
           .join();
       
      Parameters:
      timeout - the maximum time to wait
      unit - the time unit of the timeout argument
      Returns:
      the result value
      Throws:
      CancellationException - if the computation was cancelled
      CompletionException - if this future completed exceptionally or a completion computation threw an exception or the wait timed out(with the TimeoutException as its cause)
      See Also:
    • getNow

      @Contract(pure=true) @Nullable public T getNow(T valueIfAbsent)
      Returns the result value (or throws any encountered exception) if completed, else returns the given valueIfAbsent.
      Parameters:
      valueIfAbsent - the value to return if not completed
      Returns:
      the result value, if completed, else the given valueIfAbsent
      Throws:
      CancellationException - if the computation was cancelled
      CompletionException - if this future completed exceptionally or a completion computation threw an exception
      See Also:
    • getSuccessNow

      @Contract(pure=true) @Nullable public T getSuccessNow(@Nullable T valueIfNotSuccess)
      Returns the result value if completed normally, else returns the given valueIfNotSuccess.

      This method is guaranteed not to throw CompletionException, ExecutionException, CancellationException and IllegalStateException.

      Parameters:
      valueIfNotSuccess - the value to return if not completed normally
      Returns:
      the result value, if completed normally, else the given valueIfNotSuccess
    • resultNow

      @Contract(pure=true) @Nullable public T resultNow()
      Returns the computed result, without waiting.

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

      results = futures.stream()
           .filter(f -> f.state() == Future.State.SUCCESS)
           .map(Future::resultNow)
           .toList();
       
      Specified by:
      resultNow in interface Future<T>
      Returns:
      the computed result
      Throws:
      IllegalStateException - if the task has not completed or the task did not complete with a result
    • exceptionNow

      @Contract(pure=true) public Throwable exceptionNow()
      Returns the exception thrown by the task, without waiting.

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

      Specified by:
      exceptionNow in interface Future<T>
      Returns:
      the exception thrown by the task
      Throws:
      IllegalStateException - if the task has not completed, the task completed normally, or the task was cancelled
      See Also:
    • isDone

      @Contract(pure=true) public boolean isDone()
      Returns true if this task completed.

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

      Specified by:
      isDone in interface Future<T>
      Returns:
      true if this task completed
    • isCompletedExceptionally

      @Contract(pure=true) public boolean isCompletedExceptionally()
      Returns true if this Cffu completed exceptionally, in any way. Possible causes include cancellation, explicit invocation of completeExceptionally, and abrupt termination of a CompletionStage action.
      Returns:
      true if this Cffu completed exceptionally
    • isCancelled

      @Contract(pure=true) public boolean isCancelled()
      Returns true if this Cffu was cancelled before it completed normally.
      Specified by:
      isCancelled in interface Future<T>
      Returns:
      true if this Cffu was cancelled before it completed normally
    • state

      @Contract(pure=true) public Future.State state()
      Returns the computation state. This method does not provide Java version compatibility logic; For Java 18-, use cffuState() instead.

      NOTE: Both CompletableFuture.state() method and its return type Future.State were introduced in Java 19. The dependency on the new return type makes it IMPOSSIBLE to provide backward compatibility through the Cffu wrapper.

      Specified by:
      state in interface Future<T>
      Returns:
      the computation state
      See Also:
    • cffuState

      @Contract(pure=true) public CffuState cffuState()
      Returns the computation state (CffuState). This method provides equivalent functionality to CompletableFuture.state() with backwards compatibility for Java 18-.
      Returns:
      the computation state
    • complete

      public boolean complete(@Nullable T value)
      If not already completed, sets the value returned by get() and related methods to the given value.
      Parameters:
      value - the result value
      Returns:
      true if this invocation caused this Cffu to transition to a completed state, else false
    • completeAsync

      @Contract("_ -> this") public Cffu<T> completeAsync(Supplier<? extends T> supplier)
      Completes this Cffu with the result of the given Supplier function invoked from an asynchronous task using defaultExecutor().
      Parameters:
      supplier - a function returning the value to be used to complete this Cffu
      Returns:
      this Cffu
    • completeAsync

      @Contract("_, _ -> this") public Cffu<T> completeAsync(Supplier<? extends T> supplier, Executor executor)
      Completes this Cffu with the result of the given Supplier function invoked from an asynchronous task using the given executor.
      Parameters:
      supplier - a function returning the value to be used to complete this Cffu
      executor - the executor to use for asynchronous execution
      Returns:
      this Cffu
    • completeExceptionally

      public boolean completeExceptionally(Throwable ex)
      If not already completed, causes invocations of get() and related methods to throw the given exception.
      Parameters:
      ex - the exception
      Returns:
      true if this invocation caused this Cffu to transition to a completed state, else false
    • completeExceptionallyAsync

      @Contract("_ -> this") public Cffu<T> completeExceptionallyAsync(Supplier<? extends Throwable> supplier)
      If not already completed, completes this Cffu with the exception result of the given Supplier function invoked from an asynchronous task using the default executor.
      Parameters:
      supplier - a function returning the value to be used to complete this Cffu
      Returns:
      this Cffu
    • completeExceptionallyAsync

      @Contract("_, _ -> this") public Cffu<T> completeExceptionallyAsync(Supplier<? extends Throwable> supplier, Executor executor)
      If not already completed, completes this Cffu with the exception result of the given Supplier function invoked from an asynchronous task using the given executor.
      Parameters:
      supplier - a function returning the value to be used to complete this Cffu
      executor - the executor to use for asynchronous execution
      Returns:
      this Cffu
    • cancel

      public boolean cancel(boolean mayInterruptIfRunning)
      If not already completed, completes this Cffu with a CancellationException. Dependent Cffus that have not already completed will also complete exceptionally, with a CompletionException caused by this CancellationException.
      Specified by:
      cancel in interface Future<T>
      Parameters:
      mayInterruptIfRunning - this value has no effect in this implementation because interrupts are not used to control processing.
      Returns:
      true if this task is now cancelled
    • minimalCompletionStage

      @Contract(pure=true) public CompletionStage<T> minimalCompletionStage()
      Returns a new CompletionStage that is completed normally with the same value as this Cffu when it completes normally, and cannot be independently completed or otherwise used in ways not defined by the methods of interface CompletionStage. If this Cffu completes exceptionally, then the returned CompletionStage completes exceptionally with a CompletionException with this exception as cause.

      demo code about re-config methods of Cffu:

      cffu2 = cffu
           .withDefaultExecutor(executor2) // reset to use executor2
           .minimalCompletionStage();      // restrict to methods of 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.

    • withDefaultExecutor

      @Contract(pure=true) public Cffu<T> withDefaultExecutor(Executor defaultExecutor)
      Returns a new Cffu with the given defaultExecutor.

      Note: The provided defaultExecutor will only affect subsequent newly created Cffu instances, and will not affect this Cffu instance.

      demo code about re-config methods of Cffu:

      cffu2 = cffu
           .withDefaultExecutor(executor2) // reset to use executor2
           .minimalCompletionStage();      // restrict to methods of CompletionStage
       
      See Also:
    • withCffuFactory

      @Contract(pure=true) public Cffu<T> withCffuFactory(CffuFactory cffuFactory)
      Returns a new Cffu with the given CffuFactory(contained configuration).

      Note: The provided CffuFactory configuration will only affect subsequent newly created Cffu instances, and will not affect this Cffu instance.

      demo code about re-config methods of Cffu:

      cffu2 = cffu
           .withCffuFactory(cffuFactory2) // reset to use config from cffuFactory2
           .minimalCompletionStage();     // restrict to methods of CompletionStage
       
      Parameters:
      cffuFactory - cffuFactory contained configuration
      See Also:
    • toCompletableFuture

      @Contract(pure=true) public CompletableFuture<T> toCompletableFuture()
      Returns a CompletableFuture maintaining the same completion properties as this Cffu.

      Calling this method is same as calling the CompletableFuture.toCompletableFuture() method of the underlying CompletableFuture: underlyingCf.toCompletableFuture(); CompletableFutureUtils.toCompletableFutureArray(CompletionStage[]) is the batch operation of this method. If you need the underlying CompletableFuture instance, call method cffuUnwrap().

      Specified by:
      toCompletableFuture in interface CompletionStage<T>
      Returns:
      the CompletableFuture
      See Also:
    • copy

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

      @Contract(pure=true) public Executor defaultExecutor()
      Returns the default Executor used for async methods that do not specify an Executor. Config from the CffuFactory.defaultExecutor(), and can re-configured by withCffuFactory(CffuFactory).
      Returns:
      the default executor
      See Also:
    • cffuFactory

      @Contract(pure=true) public CffuFactory cffuFactory()
      Returns the CffuFactory of this Cffu. This can be re-configured by withCffuFactory(CffuFactory).
      Returns:
      the CffuFactory
      See Also:
    • forbidObtrudeMethods

      @Contract(pure=true) public boolean forbidObtrudeMethods()
      Returns forbidObtrudeMethods or not. This can be re-configured by withCffuFactory(CffuFactory).
      See Also:
    • isMinimalStage

      @Contract(pure=true) public boolean isMinimalStage()
      Returns whether is a minimal stage or not.

      create a minimal stage by below methods:

    • getNumberOfDependents

      @Contract(pure=true) public int getNumberOfDependents()
      Returns the estimated number of CompletableFuture(including Cffu wrapper) whose completions are awaiting completion of this Cffu(aka its underlying CompletableFuture). This method is designed for use in monitoring system state, not for synchronization control.
      Returns:
      the estimated number of dependent CompletableFutures(including Cffu wrapper)
      See Also:
    • obtrudeValue

      public void obtrudeValue(@Nullable T value)
      Forcibly sets or resets the value subsequently returned by method get() and related methods, whether already completed or not. This method is designed for use only in error recovery actions, and even in such situations may result in ongoing dependent completions using established versus overwritten outcomes.
      Parameters:
      value - the completion value
      See Also:
    • obtrudeException

      public void obtrudeException(Throwable ex)
      Forcibly causes subsequent invocations of method get() and related methods to throw the given exception, whether already completed or not. This method is designed for use only in error recovery actions, and even in such situations may result in ongoing dependent completions using established versus overwritten outcomes.
      Parameters:
      ex - the exception
      Throws:
      NullPointerException - if the exception is null
      See Also:
    • cffuUnwrap

      @Contract(pure=true) public CompletableFuture<T> cffuUnwrap()
      Returns the underlying CompletableFuture.

      CAUTION: This method is NOT type safe! The returned CompletableFuture may be a minimal-stage. In general, you should NEVER use this method, use toCompletableFuture() instead.

      Returns:
      the underlying CompletableFuture
      See Also:
    • newIncompleteFuture

      @Contract(pure=true) public <U> Cffu<U> newIncompleteFuture()
      Returns a new incomplete Cffu with CompletableFuture of the type to be returned by a CompletionStage method.

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

      See Also:
    • toString

      @Contract(pure=true) public String toString()
      Returns a string identifying this Cffu, as well as its completion state.

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

      Overrides:
      toString in class Object
      Returns:
      a string identifying this Cffu, as well as its state
      See Also: