Most visited

Recently visited

Results for

Added in API level 24

Summary: Methods | [Expand All]

CompletionStage

public interface CompletionStage

java.util.concurrent.CompletionStage<T>

Known Indirect Subclasses

CompletableFuture<T>

A stage of a possibly asynchronous computation, that performs an action or computes a value when another CompletionStage completes. A stage completes upon termination of its computation, but this may in turn trigger other dependent stages. The functionality defined in this interface takes only a few basic forms, which expand out to a larger set of methods to capture a range of usage styles:

The computation performed by a stage may be expressed as a Function, Consumer, or Runnable (using methods with names including apply, accept, or run, respectively) depending on whether it requires arguments and/or produces results. For example:
```
 stage.thenApply(x -> square(x))
      .thenAccept(x -> System.out.print(x))
      .thenRun(() -> System.out.println());
```
An additional form (compose) allows the construction of computation pipelines from functions returning completion stages.
Any argument to a stage's computation is the outcome of a triggering stage's computation.
One stage's execution may be triggered by completion of a single stage, or both of two stages, or either of two stages. Dependencies on a single stage are arranged using methods with prefix then. Those triggered by completion of both of two stages may combine their results or effects, using correspondingly named methods. Those triggered by either of two stages make no guarantees about which of the results or effects are used for the dependent stage's computation.
Dependencies among stages control the triggering of computations, but do not otherwise guarantee any particular ordering. Additionally, execution of a new stage's computations may be arranged in any of three ways: default execution, default asynchronous execution (using methods with suffix async that employ the stage's default asynchronous execution facility), or custom (via a supplied Executor). The execution properties of default and async modes are specified by CompletionStage implementations, not this interface. Methods with explicit Executor arguments may have arbitrary execution properties, and might not even support concurrent execution, but are arranged for processing in a way that accommodates asynchrony.
Two method forms (handle and whenComplete) support unconditional computation whether the triggering stage completed normally or exceptionally. Method exceptionally supports computation only when the triggering stage completes exceptionally, computing a replacement result, similarly to the java catch keyword. In all other cases, if a stage's computation terminates abruptly with an (unchecked) exception or error, then all dependent stages requiring its completion complete exceptionally as well, with a CompletionException holding the exception as its cause. If a stage is dependent on both of two stages, and both complete exceptionally, then the CompletionException may correspond to either one of these exceptions. If a stage is dependent on either of two others, and only one of them completes exceptionally, no guarantees are made about whether the dependent stage completes normally or exceptionally. In the case of method whenComplete, when the supplied action itself encounters an exception, then the stage completes exceptionally with this exception unless the source stage also completed exceptionally, in which case the exceptional completion from the source stage is given preference and propagated to the dependent stage.

All methods adhere to the above triggering, execution, and exceptional completion specifications (which are not repeated in individual method specifications). Additionally, while arguments used to pass a completion result (that is, for parameters of type T) for methods accepting them may be null, passing a null value for any other parameter will result in a NullPointerException being thrown.

Method form handle is the most general way of creating a continuation stage, unconditionally performing a computation that is given both the result and exception (if any) of the triggering CompletionStage, and computing an arbitrary result. Method whenComplete is similar, but preserves the result of the triggering stage instead of computing a new one. Because a stage's normal result may be null, both methods should have a computation structured thus:

(result, exception) -> {
   if (exception == null) {
     // triggering stage completed normally
   } else {
     // triggering stage completed exceptionally
   }
 }

This interface does not define methods for initially creating, forcibly completing normally or exceptionally, probing completion status or results, or awaiting completion of a stage. Implementations of CompletionStage may provide means of achieving such effects, as appropriate. Method toCompletableFuture() enables interoperability among different implementations of this interface by providing a common conversion type.

Summary

Public methods
`abstract CompletionStage<Void>`	`acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)` Returns a new CompletionStage that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied action.
`abstract CompletionStage<Void>`	`acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)` Returns a new CompletionStage 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.
`abstract CompletionStage<Void>`	`acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)` Returns a new CompletionStage that, when either this or the other given stage complete normally, is executed using this stage's default asynchronous execution facility, with the corresponding result as argument to the supplied action.
`abstract <U> CompletionStage<U>`	`applyToEither(CompletionStage<? extends T> other, Function<? super T, U> fn)` Returns a new CompletionStage that, when either this or the other given stage complete normally, is executed with the corresponding result as argument to the supplied function.
`abstract <U> CompletionStage<U>`	`applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn, Executor executor)` Returns a new CompletionStage 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.
`abstract <U> CompletionStage<U>`	`applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn)` Returns a new CompletionStage that, when either this or the other given stage complete normally, is executed using this stage's default asynchronous execution facility, with the corresponding result as argument to the supplied function.
`abstract CompletionStage<T>`	`exceptionally(Function<Throwable, ? extends T> fn)` Returns a new CompletionStage that, when this stage completes exceptionally, is executed with this stage's exception as the argument to the supplied function.
`abstract <U> CompletionStage<U>`	`handle(BiFunction<? super T, Throwable, ? extends U> fn)` Returns a new CompletionStage that, when this stage completes either normally or exceptionally, is executed with this stage's result and exception as arguments to the supplied function.
`abstract <U> CompletionStage<U>`	`handleAsync(BiFunction<? super T, Throwable, ? extends U> fn, Executor executor)` Returns a new CompletionStage that, when this stage completes either normally or exceptionally, is executed using the supplied executor, with this stage's result and exception as arguments to the supplied function.
`abstract <U> CompletionStage<U>`	`handleAsync(BiFunction<? super T, Throwable, ? extends U> fn)` Returns a new CompletionStage that, when this stage completes either normally or exceptionally, is executed using this stage's default asynchronous execution facility, with this stage's result and exception as arguments to the supplied function.
`abstract CompletionStage<Void>`	`runAfterBoth(CompletionStage<?> other, Runnable action)` Returns a new CompletionStage that, when this and the other given stage both complete normally, executes the given action.
`abstract CompletionStage<Void>`	`runAfterBothAsync(CompletionStage<?> other, Runnable action)` Returns a new CompletionStage that, when this and the other given stage both complete normally, executes the given action using this stage's default asynchronous execution facility.
`abstract CompletionStage<Void>`	`runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)` Returns a new CompletionStage that, when this and the other given stage both complete normally, executes the given action using the supplied executor.
`abstract CompletionStage<Void>`	`runAfterEither(CompletionStage<?> other, Runnable action)` Returns a new CompletionStage that, when either this or the other given stage complete normally, executes the given action.
`abstract CompletionStage<Void>`	`runAfterEitherAsync(CompletionStage<?> other, Runnable action)` Returns a new CompletionStage that, when either this or the other given stage complete normally, executes the given action using this stage's default asynchronous execution facility.
`abstract CompletionStage<Void>`	`runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)` Returns a new CompletionStage that, when either this or the other given stage complete normally, executes the given action using the supplied executor.
`abstract CompletionStage<Void>`	`thenAccept(Consumer<? super T> action)` Returns a new CompletionStage that, when this stage completes normally, is executed with this stage's result as the argument to the supplied action.
`abstract CompletionStage<Void>`	`thenAcceptAsync(Consumer<? super T> action, Executor executor)` Returns a new CompletionStage that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied action.
`abstract CompletionStage<Void>`	`thenAcceptAsync(Consumer<? super T> action)` Returns a new CompletionStage that, when this stage completes normally, is executed using this stage's default asynchronous execution facility, with this stage's result as the argument to the supplied action.
`abstract <U> CompletionStage<Void>`	`thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)` Returns a new CompletionStage that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied action.
`abstract <U> CompletionStage<Void>`	`thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action, Executor executor)` Returns a new CompletionStage 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.
`abstract <U> CompletionStage<Void>`	`thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)` Returns a new CompletionStage that, when this and the other given stage both complete normally, is executed using this stage's default asynchronous execution facility, with the two results as arguments to the supplied action.
`abstract <U> CompletionStage<U>`	`thenApply(Function<? super T, ? extends U> fn)` Returns a new CompletionStage that, when this stage completes normally, is executed with this stage's result as the argument to the supplied function.
`abstract <U> CompletionStage<U>`	`thenApplyAsync(Function<? super T, ? extends U> fn)` Returns a new CompletionStage that, when this stage completes normally, is executed using this stage's default asynchronous execution facility, with this stage's result as the argument to the supplied function.
`abstract <U> CompletionStage<U>`	`thenApplyAsync(Function<? super T, ? extends U> fn, Executor executor)` Returns a new CompletionStage that, when this stage completes normally, is executed using the supplied Executor, with this stage's result as the argument to the supplied function.
`abstract <U, V> CompletionStage<V>`	`thenCombine(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn)` Returns a new CompletionStage that, when this and the other given stage both complete normally, is executed with the two results as arguments to the supplied function.
`abstract <U, V> CompletionStage<V>`	`thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn)` Returns a new CompletionStage that, when this and the other given stage both complete normally, is executed using this stage's default asynchronous execution facility, with the two results as arguments to the supplied function.
`abstract <U, V> CompletionStage<V>`	`thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T, ? super U, ? extends V> fn, Executor executor)` Returns a new CompletionStage 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.
`abstract <U> CompletionStage<U>`	`thenCompose(Function<? super T, ? extends CompletionStage<U>> fn)` Returns a new CompletionStage that is completed with the same value as the CompletionStage returned by the given function.
`abstract <U> CompletionStage<U>`	`thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn, Executor executor)` Returns a new CompletionStage that is completed with the same value as the CompletionStage returned by the given function, executed using the supplied Executor.
`abstract <U> CompletionStage<U>`	`thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn)` Returns a new CompletionStage that is completed with the same value as the CompletionStage returned by the given function, executed using this stage's default asynchronous execution facility.
`abstract CompletionStage<Void>`	`thenRun(Runnable action)` Returns a new CompletionStage that, when this stage completes normally, executes the given action.
`abstract CompletionStage<Void>`	`thenRunAsync(Runnable action, Executor executor)` Returns a new CompletionStage that, when this stage completes normally, executes the given action using the supplied Executor.
`abstract CompletionStage<Void>`	`thenRunAsync(Runnable action)` Returns a new CompletionStage that, when this stage completes normally, executes the given action using this stage's default asynchronous execution facility.
`abstract CompletableFuture<T>`	`toCompletableFuture()` Returns a `CompletableFuture` maintaining the same completion properties as this stage.
`abstract CompletionStage<T>`	`whenComplete(BiConsumer<? super T, ? super Throwable> action)` Returns a new CompletionStage with the same result or exception as this stage, that executes the given action when this stage completes.
`abstract CompletionStage<T>`	`whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action)` Returns a new CompletionStage with the same result or exception as this stage, that executes the given action using this stage's default asynchronous execution facility when this stage completes.
`abstract CompletionStage<T>`	`whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action, Executor executor)` Returns a new CompletionStage with the same result or exception as this stage, that executes the given action using the supplied Executor when this stage completes.

Parameters
`other`	`CompletionStage`: the other CompletionStage
`action`	`Consumer`: the action to perform before completing the returned CompletionStage

Parameters
`other`	`CompletionStage`: the other CompletionStage
`fn`	`Function`: the function to use to compute the value of the returned CompletionStage

Parameters
`fn`	`BiFunction`: the function to use to compute the value of the returned CompletionStage
`executor`	`Executor`: the executor to use for asynchronous execution

Parameters
`action`	`Runnable`: the action to perform before completing the returned CompletionStage
`executor`	`Executor`: the executor to use for asynchronous execution

Parameters
`action`	`BiConsumer`: the action to perform
`executor`	`Executor`: the executor to use for asynchronous execution

Most visited

Recently visited

Results for

CompletionStage

Summary

Public methods

Public methods

acceptEither

acceptEitherAsync

acceptEitherAsync

applyToEither

applyToEitherAsync

applyToEitherAsync

exceptionally

handle

handleAsync

handleAsync

runAfterBoth

runAfterBothAsync

runAfterBothAsync

runAfterEither

runAfterEitherAsync

runAfterEitherAsync

thenAccept

thenAcceptAsync

thenAcceptAsync

thenAcceptBoth

thenAcceptBothAsync

thenAcceptBothAsync

thenApply

thenApplyAsync

thenApplyAsync

thenCombine

thenCombineAsync

thenCombineAsync

thenCompose

thenComposeAsync

thenComposeAsync

thenRun

thenRunAsync

thenRunAsync

toCompletableFuture

whenComplete

whenCompleteAsync

whenCompleteAsync