com.jn.langx.util.concurrent.completion

类 CompletableFuture<T>

java.lang.Object

com.jn.langx.util.concurrent.completion.CompletableFuture<T>

所有已实现的接口:

CompletionStep<T>, Future<T>

public class CompletableFuture<T>
extends Object
implements Future<T>, CompletionStep<T>

A { Future} that may be explicitly completed (setting its value and status), and may be used as a { CompletionStep}, supporting dependent functions and actions that trigger upon its completion.

When two or more threads attempt to { #complete complete}, { #completeExceptionally completeExceptionally}, or { #cancel cancel} a CompletableFuture, only one of them succeeds.

In addition to these and related methods for directly manipulating status and results, CompletableFuture implements interface { CompletionStep} with the following policies:

• Actions supplied for dependent completions of non-async methods may be performed by the thread that completes the current CompletableFuture, or by any other caller of a completion method.
• All async methods without an explicit Executor argument are performed using the { ForkJoinPool#commonPool()} (unless it does not support a parallelism level of at least two, in which case, a new Thread is created to run each task). To simplify monitoring, debugging, and tracking, all generated asynchronous tasks are instances of the marker interface { AsynchronousCompletionTask}.
• All CompletionStep methods are implemented independently of other public methods, so the behavior of one method is not impacted by overrides of others in subclasses.

CompletableFuture also implements { Future} with the following policies:

• Since (unlike { FutureTask}) this class has no direct control over the computation that causes it to be completed, cancellation is treated as just another form of exceptional completion. Method { #cancel cancel} has the same effect as completeExceptionally(new CancellationException()). Method { #isCompletedExceptionally} can be used to determine if a CompletableFuture completed in any exceptional fashion.
• In case of exceptional completion with a CompletionException, methods { #get()} and { #get(long, TimeUnit)} throw an { ExecutionException} with the same cause as held in the corresponding CompletionException. To simplify usage in most contexts, this class also defines methods { #join()} and { #getNow} that instead throw the CompletionException directly in these cases.

作者:

Doug Lea

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	CompletableFuture.AsynchronousCompletionTask A marker interface identifying asynchronous tasks produced by async methods.

构造器概要

构造器

构造器和说明
CompletableFuture() Creates a new incomplete CompletableFuture.

方法概要

限定符和类型	方法和说明
CompletableFuture<Void>	acceptEither(CompletionStep<? 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.
CompletableFuture<Void>	acceptEitherAsync(CompletionStep<? 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.
CompletableFuture<Void>	acceptEitherAsync(CompletionStep<? 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.
static CompletableFuture<Void>	allOf(CompletableFuture<?>... cfs) Returns a new CompletableFuture that is completed when all of the given CompletableFutures complete.
static CompletableFuture<Object>	anyOf(CompletableFuture<?>... cfs) Returns a new CompletableFuture that is completed when any of the given CompletableFutures complete, with the same result.
<U> CompletableFuture<U>	applyToEither(CompletionStep<? 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.
<U> CompletableFuture<U>	applyToEitherAsync(CompletionStep<? 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.
<U> CompletableFuture<U>	applyToEitherAsync(CompletionStep<? 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.
boolean	cancel(boolean mayInterruptIfRunning) If not already completed, completes this CompletableFuture with a { CancellationException}.
boolean	complete(T value) If not already completed, sets the value returned by { #get()} and related methods to the given value.
static <U> CompletableFuture<U>	completedFuture(U value) Returns a new CompletableFuture that is already completed with the given value.
boolean	completeExceptionally(Throwable ex) If not already completed, causes invocations of { #get()} and related methods to throw the given exception.
CompletableFuture<T>	exceptionally(Function<Throwable,? extends T> fn) Returns a new CompletableFuture that is completed when this CompletableFuture completes, with the result of the given function of the exception triggering this CompletableFuture's completion when it completes exceptionally; otherwise, if this CompletableFuture completes normally, then the returned CompletableFuture also completes normally with the same value.
T	get() Waits if necessary for this future to complete, and then returns its result.
T	get(long timeout, TimeUnit unit) Waits if necessary for at most the given time for this future to complete, and then returns its result, if available.
T	getNow(T valueIfAbsent) Returns the result value (or throws any encountered exception) if completed, else returns the given valueIfAbsent.
int	getNumberOfDependents() Returns the estimated number of CompletableFutures whose completions are awaiting completion of this CompletableFuture.
<U> CompletableFuture<U>	handle(Function2<? 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.
<U> CompletableFuture<U>	handleAsync(Function2<? 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.
<U> CompletableFuture<U>	handleAsync(Function2<? 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.
boolean	isCancelled() Returns true if this CompletableFuture was cancelled before it completed normally.
boolean	isCompletedExceptionally() Returns true if this CompletableFuture completed exceptionally, in any way.
boolean	isDone() Returns true if completed in any fashion: normally, exceptionally, or via cancellation.
T	join() Returns the result value when complete, or throws an (unchecked) exception if completed exceptionally.
void	obtrudeException(Throwable ex) Forcibly causes subsequent invocations of method { #get()} and related methods to throw the given exception, whether or not already completed.
void	obtrudeValue(T value) Forcibly sets or resets the value subsequently returned by method { #get()} and related methods, whether or not already completed.
CompletableFuture<Void>	runAfterBoth(CompletionStep<?> other, Runnable action) Returns a new CompletionStage that, when this and the other given stage both complete normally, executes the given action.
CompletableFuture<Void>	runAfterBothAsync(CompletionStep<?> 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.
CompletableFuture<Void>	runAfterBothAsync(CompletionStep<?> 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.
CompletableFuture<Void>	runAfterEither(CompletionStep<?> other, Runnable action) Returns a new CompletionStage that, when either this or the other given stage complete normally, executes the given action.
CompletableFuture<Void>	runAfterEitherAsync(CompletionStep<?> 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.
CompletableFuture<Void>	runAfterEitherAsync(CompletionStep<?> 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.
static CompletableFuture<Void>	runAsync(Runnable runnable) Returns a new CompletableFuture that is asynchronously completed by a task running in the { ForkJoinPool#commonPool()} after it runs the given action.
static CompletableFuture<Void>	runAsync(Runnable runnable, Executor executor) Returns a new CompletableFuture that is asynchronously completed by a task running in the given executor after it runs the given action.
static <U> CompletableFuture<U>	supplyAsync(Supplier0<U> supplier0) Returns a new CompletableFuture that is asynchronously completed by a task running in the { ForkJoinPool#commonPool()} with the value obtained by calling the given Supplier0.
static <U> CompletableFuture<U>	supplyAsync(Supplier0<U> supplier0, Executor executor) Returns a new CompletableFuture that is asynchronously completed by a task running in the given executor with the value obtained by calling the given Supplier0.
CompletableFuture<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.
CompletableFuture<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.
CompletableFuture<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.
<U> CompletableFuture<Void>	thenAcceptBoth(CompletionStep<? extends U> other, Consumer2<? 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.
<U> CompletableFuture<Void>	thenAcceptBothAsync(CompletionStep<? extends U> other, Consumer2<? 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.
<U> CompletableFuture<Void>	thenAcceptBothAsync(CompletionStep<? extends U> other, Consumer2<? 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.
<U> CompletableFuture<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.
<U> CompletableFuture<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.
<U> CompletableFuture<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.
<U,V> CompletableFuture<V>	thenCombine(CompletionStep<? extends U> other, Function2<? 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.
<U,V> CompletableFuture<V>	thenCombineAsync(CompletionStep<? extends U> other, Function2<? 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.
<U,V> CompletableFuture<V>	thenCombineAsync(CompletionStep<? extends U> other, Function2<? 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.
<U> CompletableFuture<U>	thenCompose(Function<? super T,? extends CompletionStep<U>> fn) Returns a new CompletionStage that is completed with the same value as the CompletionStage returned by the given function.
<U> CompletableFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStep<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.
<U> CompletableFuture<U>	thenComposeAsync(Function<? super T,? extends CompletionStep<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.
CompletableFuture<Void>	thenRun(Runnable action) Returns a new CompletionStage that, when this stage completes normally, executes the given action.
CompletableFuture<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.
CompletableFuture<Void>	thenRunAsync(Runnable action, Executor executor) Returns a new CompletionStage that, when this stage completes normally, executes the given action using the supplied Executor.
CompletableFuture<T>	toCompletableFuture() Returns this CompletableFuture.
String	toString() Returns a string identifying this CompletableFuture, as well as its completion state.
CompletableFuture<T>	whenComplete(Consumer2<? 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.
CompletableFuture<T>	whenCompleteAsync(Consumer2<? 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.
CompletableFuture<T>	whenCompleteAsync(Consumer2<? 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.

从类继承的方法 java.lang.Object

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

构造器详细资料

CompletableFuture

public CompletableFuture()

Creates a new incomplete CompletableFuture.

方法详细资料

supplyAsync

public static <U> CompletableFuture<U> supplyAsync(Supplier0<U> supplier0)

Returns a new CompletableFuture that is asynchronously completed by a task running in the { ForkJoinPool#commonPool()} with the value obtained by calling the given Supplier0.

类型参数:

U - the function's return type

参数:

supplier0 - a function returning the value to be used to complete the returned CompletableFuture

返回:

the new CompletableFuture

supplyAsync

public static <U> CompletableFuture<U> supplyAsync(Supplier0<U> supplier0,
                                                   Executor executor)

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

类型参数:

U - the function's return type

参数:

supplier0 - a function returning the value to be used to complete the returned CompletableFuture

executor - the executor to use for asynchronous execution

返回:

the new CompletableFuture

runAsync

public static CompletableFuture<Void> runAsync(Runnable runnable)

Returns a new CompletableFuture that is asynchronously completed by a task running in the { ForkJoinPool#commonPool()} after it runs the given action.

参数:

runnable - the action to run before completing the returned CompletableFuture

返回:

the new CompletableFuture

runAsync

public static CompletableFuture<Void> runAsync(Runnable runnable,
                                               Executor executor)

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

参数:

runnable - the action to run before completing the returned CompletableFuture

executor - the executor to use for asynchronous execution

返回:

the new CompletableFuture

completedFuture

public static <U> CompletableFuture<U> completedFuture(U value)

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

类型参数:

U - the type of the value

参数:

value - the value

返回:

the completed CompletableFuture

isDone

public boolean isDone()

Returns true if completed in any fashion: normally, exceptionally, or via cancellation.

指定者:

isDone 在接口中 Future<T>

返回:

true if completed

get

public T get()
      throws InterruptedException,
             ExecutionException

Waits if necessary for this future to complete, and then returns its result.

指定者:

get 在接口中 Future<T>

返回:

the result value

抛出:

CancellationException - if this future was cancelled

ExecutionException - if this future completed exceptionally

InterruptedException - if the current thread was interrupted while waiting

get

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

Waits if necessary for at most the given time for this future to complete, and then returns its result, if available.

指定者:

get 在接口中 Future<T>

参数:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

返回:

the result value

抛出:

CancellationException - if this future was cancelled

ExecutionException - if this future completed exceptionally

InterruptedException - if the current thread was interrupted while waiting

TimeoutException - if the wait timed out

join

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 CompletableFuture threw an exception, this method throws an (unchecked) { CompletionException} with the underlying exception as its cause.

返回:

the result value

抛出:

CancellationException - if the computation was cancelled

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

getNow

public T getNow(T valueIfAbsent)

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

参数:

valueIfAbsent - the value to return if not completed

返回:

the result value, if completed, else the given valueIfAbsent

抛出:

CancellationException - if the computation was cancelled

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

complete

public boolean complete(T value)

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

参数:

value - the result value

返回:

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

completeExceptionally

public boolean completeExceptionally(Throwable ex)

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

参数:

ex - the exception

返回:

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

thenApply

public <U> CompletableFuture<U> thenApply(Function<? super T,? extends U> fn)

从接口复制的说明: CompletionStep

Returns a new CompletionStage 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 { java.util.Optional#map Optional.map} and { java.util.stream.Stream#map Stream.map}.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenApply 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

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

返回:

the new CompletionStage

thenApplyAsync

public <U> CompletableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenApplyAsync 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

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

返回:

the new CompletionStage

thenApplyAsync

public <U> CompletableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn,
                                               Executor executor)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenApplyAsync 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

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

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

thenAccept

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

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenAccept 在接口中 CompletionStep<T>

参数:

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

thenAcceptAsync

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

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenAcceptAsync 在接口中 CompletionStep<T>

参数:

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

thenAcceptAsync

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

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenAcceptAsync 在接口中 CompletionStep<T>

参数:

action - the action to perform before completing the returned CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

thenRun

public CompletableFuture<Void> thenRun(Runnable action)

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenRun 在接口中 CompletionStep<T>

参数:

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

thenRunAsync

public CompletableFuture<Void> thenRunAsync(Runnable action)

从接口复制的说明: CompletionStep

Returns a new CompletionStage that, when this stage completes normally, executes the given action using this stage's default asynchronous execution facility.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenRunAsync 在接口中 CompletionStep<T>

参数:

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

thenRunAsync

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

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenRunAsync 在接口中 CompletionStep<T>

参数:

action - the action to perform before completing the returned CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

thenCombine

public <U,V> CompletableFuture<V> thenCombine(CompletionStep<? extends U> other,
                                              Function2<? super T,? super U,? extends V> fn)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenCombine 在接口中 CompletionStep<T>

类型参数:

U - the type of the other CompletionStage's result

V - the function's return type

参数:

other - the other CompletionStage

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

返回:

the new CompletionStage

thenCombineAsync

public <U,V> CompletableFuture<V> thenCombineAsync(CompletionStep<? extends U> other,
                                                   Function2<? super T,? super U,? extends V> fn)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenCombineAsync 在接口中 CompletionStep<T>

类型参数:

U - the type of the other CompletionStage's result

V - the function's return type

参数:

other - the other CompletionStage

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

返回:

the new CompletionStage

thenCombineAsync

public <U,V> CompletableFuture<V> thenCombineAsync(CompletionStep<? extends U> other,
                                                   Function2<? super T,? super U,? extends V> fn,
                                                   Executor executor)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenCombineAsync 在接口中 CompletionStep<T>

类型参数:

U - the type of the other CompletionStage's result

V - the function's return type

参数:

other - the other CompletionStage

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

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

thenAcceptBoth

public <U> CompletableFuture<Void> thenAcceptBoth(CompletionStep<? extends U> other,
                                                  Consumer2<? super T,? super U> action)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenAcceptBoth 在接口中 CompletionStep<T>

类型参数:

U - the type of the other CompletionStage's result

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

thenAcceptBothAsync

public <U> CompletableFuture<Void> thenAcceptBothAsync(CompletionStep<? extends U> other,
                                                       Consumer2<? super T,? super U> action)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenAcceptBothAsync 在接口中 CompletionStep<T>

类型参数:

U - the type of the other CompletionStage's result

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

thenAcceptBothAsync

public <U> CompletableFuture<Void> thenAcceptBothAsync(CompletionStep<? extends U> other,
                                                       Consumer2<? super T,? super U> action,
                                                       Executor executor)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenAcceptBothAsync 在接口中 CompletionStep<T>

类型参数:

U - the type of the other CompletionStage's result

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

runAfterBoth

public CompletableFuture<Void> runAfterBoth(CompletionStep<?> other,
                                            Runnable action)

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

runAfterBoth 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

runAfterBothAsync

public CompletableFuture<Void> runAfterBothAsync(CompletionStep<?> other,
                                                 Runnable action)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

runAfterBothAsync 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

runAfterBothAsync

public CompletableFuture<Void> runAfterBothAsync(CompletionStep<?> other,
                                                 Runnable action,
                                                 Executor executor)

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

runAfterBothAsync 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

applyToEither

public <U> CompletableFuture<U> applyToEither(CompletionStep<? extends T> other,
                                              Function<? super T,U> fn)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

applyToEither 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

other - the other CompletionStage

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

返回:

the new CompletionStage

applyToEitherAsync

public <U> CompletableFuture<U> applyToEitherAsync(CompletionStep<? extends T> other,
                                                   Function<? super T,U> fn)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

applyToEitherAsync 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

other - the other CompletionStage

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

返回:

the new CompletionStage

applyToEitherAsync

public <U> CompletableFuture<U> applyToEitherAsync(CompletionStep<? extends T> other,
                                                   Function<? super T,U> fn,
                                                   Executor executor)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

applyToEitherAsync 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

other - the other CompletionStage

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

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

acceptEither

public CompletableFuture<Void> acceptEither(CompletionStep<? extends T> other,
                                            Consumer<? super T> action)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

acceptEither 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

acceptEitherAsync

public CompletableFuture<Void> acceptEitherAsync(CompletionStep<? extends T> other,
                                                 Consumer<? super T> action)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

acceptEitherAsync 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

acceptEitherAsync

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

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

acceptEitherAsync 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

runAfterEither

public CompletableFuture<Void> runAfterEither(CompletionStep<?> other,
                                              Runnable action)

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

runAfterEither 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

runAfterEitherAsync

public CompletableFuture<Void> runAfterEitherAsync(CompletionStep<?> other,
                                                   Runnable action)

从接口复制的说明: CompletionStep

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.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

runAfterEitherAsync 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

返回:

the new CompletionStage

runAfterEitherAsync

public CompletableFuture<Void> runAfterEitherAsync(CompletionStep<?> other,
                                                   Runnable action,
                                                   Executor executor)

从接口复制的说明: CompletionStep

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

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

runAfterEitherAsync 在接口中 CompletionStep<T>

参数:

other - the other CompletionStage

action - the action to perform before completing the returned CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

thenCompose

public <U> CompletableFuture<U> thenCompose(Function<? super T,? extends CompletionStep<U>> fn)

从接口复制的说明: CompletionStep

Returns a new CompletionStage 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 CompletionStage 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 { java.util.Optional#flatMap Optional.flatMap} and { java.util.stream.Stream#flatMap Stream.flatMap}.

See the { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenCompose 在接口中 CompletionStep<T>

类型参数:

U - the type of the returned CompletionStage's result

参数:

fn - the function to use to compute another CompletionStage

返回:

the new CompletionStage

thenComposeAsync

public <U> CompletableFuture<U> thenComposeAsync(Function<? super T,? extends CompletionStep<U>> fn)

从接口复制的说明: CompletionStep

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.

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 CompletionStage 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 { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenComposeAsync 在接口中 CompletionStep<T>

类型参数:

U - the type of the returned CompletionStage's result

参数:

fn - the function to use to compute another CompletionStage

返回:

the new CompletionStage

thenComposeAsync

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

从接口复制的说明: CompletionStep

Returns a new CompletionStage 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 CompletionStage 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 { CompletionStep} documentation for rules covering exceptional completion.

指定者:

thenComposeAsync 在接口中 CompletionStep<T>

类型参数:

U - the type of the returned CompletionStage's result

参数:

fn - the function to use to compute another CompletionStage

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

whenComplete

public CompletableFuture<T> whenComplete(Consumer2<? super T,? super Throwable> action)

从接口复制的说明: CompletionStep

Returns a new CompletionStage 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 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.

指定者:

whenComplete 在接口中 CompletionStep<T>

参数:

action - the action to perform

返回:

the new CompletionStage

whenCompleteAsync

public CompletableFuture<T> whenCompleteAsync(Consumer2<? super T,? super Throwable> action)

从接口复制的说明: CompletionStep

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.

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(Function2) 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.

指定者:

whenCompleteAsync 在接口中 CompletionStep<T>

参数:

action - the action to perform

返回:

the new CompletionStage

whenCompleteAsync

public CompletableFuture<T> whenCompleteAsync(Consumer2<? super T,? super Throwable> action,
                                              Executor executor)

从接口复制的说明: CompletionStep

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.

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(Function2,Executor) 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.

指定者:

whenCompleteAsync 在接口中 CompletionStep<T>

参数:

action - the action to perform

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

handle

public <U> CompletableFuture<U> handle(Function2<? super T,Throwable,? extends U> fn)

从接口复制的说明: CompletionStep

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.

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

指定者:

handle 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

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

返回:

the new CompletionStage

handleAsync

public <U> CompletableFuture<U> handleAsync(Function2<? super T,Throwable,? extends U> fn)

从接口复制的说明: CompletionStep

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.

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

指定者:

handleAsync 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

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

返回:

the new CompletionStage

handleAsync

public <U> CompletableFuture<U> handleAsync(Function2<? super T,Throwable,? extends U> fn,
                                            Executor executor)

从接口复制的说明: CompletionStep

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.

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

指定者:

handleAsync 在接口中 CompletionStep<T>

类型参数:

U - the function's return type

参数:

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

executor - the executor to use for asynchronous execution

返回:

the new CompletionStage

toCompletableFuture

public CompletableFuture<T> toCompletableFuture()

Returns this CompletableFuture.

指定者:

toCompletableFuture 在接口中 CompletionStep<T>

返回:

this CompletableFuture

exceptionally

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

Returns a new CompletableFuture that is completed when this CompletableFuture completes, with the result of the given function of the exception triggering this CompletableFuture's completion when it completes exceptionally; otherwise, if this CompletableFuture completes normally, then the returned CompletableFuture also completes normally with the same value. Note: More flexible versions of this functionality are available using methods whenComplete and handle.

指定者:

exceptionally 在接口中 CompletionStep<T>

参数:

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

返回:

the new CompletableFuture

allOf

public static CompletableFuture<Void> allOf(CompletableFuture<?>... cfs)

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

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

参数:

cfs - the CompletableFutures

返回:

a new CompletableFuture that is completed when all of the given CompletableFutures complete

抛出:

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

anyOf

public static CompletableFuture<Object> anyOf(CompletableFuture<?>... cfs)

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

参数:

cfs - the CompletableFutures

返回:

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

抛出:

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

cancel

public boolean cancel(boolean mayInterruptIfRunning)

If not already completed, completes this CompletableFuture with a { CancellationException}. Dependent CompletableFutures that have not already completed will also complete exceptionally, with a { CompletionException} caused by this CancellationException.

指定者:

cancel 在接口中 Future<T>

参数:

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

返回:

true if this task is now cancelled

isCancelled

public boolean isCancelled()

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

指定者:

isCancelled 在接口中 Future<T>

返回:

true if this CompletableFuture was cancelled before it completed normally

isCompletedExceptionally

public boolean isCompletedExceptionally()

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

返回:

true if this CompletableFuture completed exceptionally

obtrudeValue

public void obtrudeValue(T value)

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

参数:

value - the completion value

obtrudeException

public void obtrudeException(Throwable ex)

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

参数:

ex - the exception

抛出:

NullPointerException - if the exception is null

getNumberOfDependents

public int getNumberOfDependents()

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

返回:

the number of dependent CompletableFutures

toString

public String toString()

Returns a string identifying this CompletableFuture, 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 CompletableFutures dependent upon its completion, if any.

覆盖:

toString 在类中 Object

返回:

a string identifying this CompletableFuture, as well as its state