ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/concurrent/CompletableFuture.java
Revision: 1.216
Committed: Sun Sep 23 15:20:32 2018 UTC (5 years, 8 months ago) by jsr166
Branch: MAIN
Changes since 1.215: +12 -22 lines
Log Message:
optimize uniComposeExceptionallyStage

File Contents

# Content
1 /*
2 * Written by Doug Lea with assistance from members of JCP JSR-166
3 * Expert Group and released to the public domain, as explained at
4 * http://creativecommons.org/publicdomain/zero/1.0/
5 */
6
7 package java.util.concurrent;
8
9 import java.lang.invoke.MethodHandles;
10 import java.lang.invoke.VarHandle;
11 import java.util.concurrent.locks.LockSupport;
12 import java.util.function.BiConsumer;
13 import java.util.function.BiFunction;
14 import java.util.function.Consumer;
15 import java.util.function.Function;
16 import java.util.function.Supplier;
17
18 /**
19 * A {@link Future} that may be explicitly completed (setting its
20 * value and status), and may be used as a {@link CompletionStage},
21 * supporting dependent functions and actions that trigger upon its
22 * completion.
23 *
24 * <p>When two or more threads attempt to
25 * {@link #complete complete},
26 * {@link #completeExceptionally completeExceptionally}, or
27 * {@link #cancel cancel}
28 * a CompletableFuture, only one of them succeeds.
29 *
30 * <p>In addition to these and related methods for directly
31 * manipulating status and results, CompletableFuture implements
32 * interface {@link CompletionStage} with the following policies: <ul>
33 *
34 * <li>Actions supplied for dependent completions of
35 * <em>non-async</em> methods may be performed by the thread that
36 * completes the current CompletableFuture, or by any other caller of
37 * a completion method.
38 *
39 * <li>All <em>async</em> methods without an explicit Executor
40 * argument are performed using the {@link ForkJoinPool#commonPool()}
41 * (unless it does not support a parallelism level of at least two, in
42 * which case, a new Thread is created to run each task). This may be
43 * overridden for non-static methods in subclasses by defining method
44 * {@link #defaultExecutor()}. To simplify monitoring, debugging,
45 * and tracking, all generated asynchronous tasks are instances of the
46 * marker interface {@link AsynchronousCompletionTask}. Operations
47 * with time-delays can use adapter methods defined in this class, for
48 * example: {@code supplyAsync(supplier, delayedExecutor(timeout,
49 * timeUnit))}. To support methods with delays and timeouts, this
50 * class maintains at most one daemon thread for triggering and
51 * cancelling actions, not for running them.
52 *
53 * <li>All CompletionStage methods are implemented independently of
54 * other public methods, so the behavior of one method is not impacted
55 * by overrides of others in subclasses.
56 *
57 * <li>All CompletionStage methods return CompletableFutures. To
58 * restrict usages to only those methods defined in interface
59 * CompletionStage, use method {@link #minimalCompletionStage}. Or to
60 * ensure only that clients do not themselves modify a future, use
61 * method {@link #copy}.
62 * </ul>
63 *
64 * <p>CompletableFuture also implements {@link Future} with the following
65 * policies: <ul>
66 *
67 * <li>Since (unlike {@link FutureTask}) this class has no direct
68 * control over the computation that causes it to be completed,
69 * cancellation is treated as just another form of exceptional
70 * completion. Method {@link #cancel cancel} has the same effect as
71 * {@code completeExceptionally(new CancellationException())}. Method
72 * {@link #isCompletedExceptionally} can be used to determine if a
73 * CompletableFuture completed in any exceptional fashion.
74 *
75 * <li>In case of exceptional completion with a CompletionException,
76 * methods {@link #get()} and {@link #get(long, TimeUnit)} throw an
77 * {@link ExecutionException} with the same cause as held in the
78 * corresponding CompletionException. To simplify usage in most
79 * contexts, this class also defines methods {@link #join()} and
80 * {@link #getNow} that instead throw the CompletionException directly
81 * in these cases.
82 * </ul>
83 *
84 * <p>Arguments used to pass a completion result (that is, for
85 * parameters of type {@code T}) for methods accepting them may be
86 * null, but passing a null value for any other parameter will result
87 * in a {@link NullPointerException} being thrown.
88 *
89 * <p>Subclasses of this class should normally override the "virtual
90 * constructor" method {@link #newIncompleteFuture}, which establishes
91 * the concrete type returned by CompletionStage methods. For example,
92 * here is a class that substitutes a different default Executor and
93 * disables the {@code obtrude} methods:
94 *
95 * <pre> {@code
96 * class MyCompletableFuture<T> extends CompletableFuture<T> {
97 * static final Executor myExecutor = ...;
98 * public MyCompletableFuture() { }
99 * public <U> CompletableFuture<U> newIncompleteFuture() {
100 * return new MyCompletableFuture<U>(); }
101 * public Executor defaultExecutor() {
102 * return myExecutor; }
103 * public void obtrudeValue(T value) {
104 * throw new UnsupportedOperationException(); }
105 * public void obtrudeException(Throwable ex) {
106 * throw new UnsupportedOperationException(); }
107 * }}</pre>
108 *
109 * @author Doug Lea
110 * @param <T> The result type returned by this future's {@code join}
111 * and {@code get} methods
112 * @since 1.8
113 */
114 public class CompletableFuture<T> implements Future<T>, CompletionStage<T> {
115
116 /*
117 * Overview:
118 *
119 * A CompletableFuture may have dependent completion actions,
120 * collected in a linked stack. It atomically completes by CASing
121 * a result field, and then pops off and runs those actions. This
122 * applies across normal vs exceptional outcomes, sync vs async
123 * actions, binary triggers, and various forms of completions.
124 *
125 * Non-nullness of volatile field "result" indicates done. It may
126 * be set directly if known to be thread-confined, else via CAS.
127 * An AltResult is used to box null as a result, as well as to
128 * hold exceptions. Using a single field makes completion simple
129 * to detect and trigger. Result encoding and decoding is
130 * straightforward but tedious and adds to the sprawl of trapping
131 * and associating exceptions with targets. Minor simplifications
132 * rely on (static) NIL (to box null results) being the only
133 * AltResult with a null exception field, so we don't usually need
134 * explicit comparisons. Even though some of the generics casts
135 * are unchecked (see SuppressWarnings annotations), they are
136 * placed to be appropriate even if checked.
137 *
138 * Dependent actions are represented by Completion objects linked
139 * as Treiber stacks headed by field "stack". There are Completion
140 * classes for each kind of action, grouped into:
141 * - single-input (UniCompletion),
142 * - two-input (BiCompletion),
143 * - projected (BiCompletions using exactly one of two inputs),
144 * - shared (CoCompletion, used by the second of two sources),
145 * - zero-input source actions,
146 * - Signallers that unblock waiters.
147 * Class Completion extends ForkJoinTask to enable async execution
148 * (adding no space overhead because we exploit its "tag" methods
149 * to maintain claims). It is also declared as Runnable to allow
150 * usage with arbitrary executors.
151 *
152 * Support for each kind of CompletionStage relies on a separate
153 * class, along with two CompletableFuture methods:
154 *
155 * * A Completion class with name X corresponding to function,
156 * prefaced with "Uni", "Bi", or "Or". Each class contains
157 * fields for source(s), actions, and dependent. They are
158 * boringly similar, differing from others only with respect to
159 * underlying functional forms. We do this so that users don't
160 * encounter layers of adapters in common usages.
161 *
162 * * Boolean CompletableFuture method x(...) (for example
163 * biApply) takes all of the arguments needed to check that an
164 * action is triggerable, and then either runs the action or
165 * arranges its async execution by executing its Completion
166 * argument, if present. The method returns true if known to be
167 * complete.
168 *
169 * * Completion method tryFire(int mode) invokes the associated x
170 * method with its held arguments, and on success cleans up.
171 * The mode argument allows tryFire to be called twice (SYNC,
172 * then ASYNC); the first to screen and trap exceptions while
173 * arranging to execute, and the second when called from a task.
174 * (A few classes are not used async so take slightly different
175 * forms.) The claim() callback suppresses function invocation
176 * if already claimed by another thread.
177 *
178 * * Some classes (for example UniApply) have separate handling
179 * code for when known to be thread-confined ("now" methods) and
180 * for when shared (in tryFire), for efficiency.
181 *
182 * * CompletableFuture method xStage(...) is called from a public
183 * stage method of CompletableFuture f. It screens user
184 * arguments and invokes and/or creates the stage object. If
185 * not async and already triggerable, the action is run
186 * immediately. Otherwise a Completion c is created, and
187 * submitted to the executor if triggerable, or pushed onto f's
188 * stack if not. Completion actions are started via c.tryFire.
189 * We recheck after pushing to a source future's stack to cover
190 * possible races if the source completes while pushing.
191 * Classes with two inputs (for example BiApply) deal with races
192 * across both while pushing actions. The second completion is
193 * a CoCompletion pointing to the first, shared so that at most
194 * one performs the action. The multiple-arity methods allOf
195 * does this pairwise to form trees of completions. Method
196 * anyOf is handled differently from allOf because completion of
197 * any source should trigger a cleanStack of other sources.
198 * Each AnyOf completion can reach others via a shared array.
199 *
200 * Note that the generic type parameters of methods vary according
201 * to whether "this" is a source, dependent, or completion.
202 *
203 * Method postComplete is called upon completion unless the target
204 * is guaranteed not to be observable (i.e., not yet returned or
205 * linked). Multiple threads can call postComplete, which
206 * atomically pops each dependent action, and tries to trigger it
207 * via method tryFire, in NESTED mode. Triggering can propagate
208 * recursively, so NESTED mode returns its completed dependent (if
209 * one exists) for further processing by its caller (see method
210 * postFire).
211 *
212 * Blocking methods get() and join() rely on Signaller Completions
213 * that wake up waiting threads. The mechanics are similar to
214 * Treiber stack wait-nodes used in FutureTask, Phaser, and
215 * SynchronousQueue. See their internal documentation for
216 * algorithmic details.
217 *
218 * Without precautions, CompletableFutures would be prone to
219 * garbage accumulation as chains of Completions build up, each
220 * pointing back to its sources. So we null out fields as soon as
221 * possible. The screening checks needed anyway harmlessly ignore
222 * null arguments that may have been obtained during races with
223 * threads nulling out fields. We also try to unlink non-isLive
224 * (fired or cancelled) Completions from stacks that might
225 * otherwise never be popped: Method cleanStack always unlinks non
226 * isLive completions from the head of stack; others may
227 * occasionally remain if racing with other cancellations or
228 * removals.
229 *
230 * Completion fields need not be declared as final or volatile
231 * because they are only visible to other threads upon safe
232 * publication.
233 */
234
235 volatile Object result; // Either the result or boxed AltResult
236 volatile Completion stack; // Top of Treiber stack of dependent actions
237
238 final boolean internalComplete(Object r) { // CAS from null to r
239 return RESULT.compareAndSet(this, null, r);
240 }
241
242 /** Returns true if successfully pushed c onto stack. */
243 final boolean tryPushStack(Completion c) {
244 Completion h = stack;
245 NEXT.set(c, h); // CAS piggyback
246 return STACK.compareAndSet(this, h, c);
247 }
248
249 /** Unconditionally pushes c onto stack, retrying if necessary. */
250 final void pushStack(Completion c) {
251 do {} while (!tryPushStack(c));
252 }
253
254 /* ------------- Encoding and decoding outcomes -------------- */
255
256 static final class AltResult { // See above
257 final Throwable ex; // null only for NIL
258 AltResult(Throwable x) { this.ex = x; }
259 }
260
261 /** The encoding of the null value. */
262 static final AltResult NIL = new AltResult(null);
263
264 /** Completes with the null value, unless already completed. */
265 final boolean completeNull() {
266 return RESULT.compareAndSet(this, null, NIL);
267 }
268
269 /** Returns the encoding of the given non-exceptional value. */
270 final Object encodeValue(T t) {
271 return (t == null) ? NIL : t;
272 }
273
274 /** Completes with a non-exceptional result, unless already completed. */
275 final boolean completeValue(T t) {
276 return RESULT.compareAndSet(this, null, (t == null) ? NIL : t);
277 }
278
279 /**
280 * Returns the encoding of the given (non-null) exception as a
281 * wrapped CompletionException unless it is one already.
282 */
283 static AltResult encodeThrowable(Throwable x) {
284 return new AltResult((x instanceof CompletionException) ? x :
285 new CompletionException(x));
286 }
287
288 /** Completes with an exceptional result, unless already completed. */
289 final boolean completeThrowable(Throwable x) {
290 return RESULT.compareAndSet(this, null, encodeThrowable(x));
291 }
292
293 /**
294 * Returns the encoding of the given (non-null) exception as a
295 * wrapped CompletionException unless it is one already. May
296 * return the given Object r (which must have been the result of a
297 * source future) if it is equivalent, i.e. if this is a simple
298 * relay of an existing CompletionException.
299 */
300 static Object encodeThrowable(Throwable x, Object r) {
301 if (!(x instanceof CompletionException))
302 x = new CompletionException(x);
303 else if (r instanceof AltResult && x == ((AltResult)r).ex)
304 return r;
305 return new AltResult(x);
306 }
307
308 /**
309 * Completes with the given (non-null) exceptional result as a
310 * wrapped CompletionException unless it is one already, unless
311 * already completed. May complete with the given Object r
312 * (which must have been the result of a source future) if it is
313 * equivalent, i.e. if this is a simple propagation of an
314 * existing CompletionException.
315 */
316 final boolean completeThrowable(Throwable x, Object r) {
317 return RESULT.compareAndSet(this, null, encodeThrowable(x, r));
318 }
319
320 /**
321 * Returns the encoding of the given arguments: if the exception
322 * is non-null, encodes as AltResult. Otherwise uses the given
323 * value, boxed as NIL if null.
324 */
325 Object encodeOutcome(T t, Throwable x) {
326 return (x == null) ? (t == null) ? NIL : t : encodeThrowable(x);
327 }
328
329 /**
330 * Returns the encoding of a copied outcome; if exceptional,
331 * rewraps as a CompletionException, else returns argument.
332 */
333 static Object encodeRelay(Object r) {
334 Throwable x;
335 if (r instanceof AltResult
336 && (x = ((AltResult)r).ex) != null
337 && !(x instanceof CompletionException))
338 r = new AltResult(new CompletionException(x));
339 return r;
340 }
341
342 /**
343 * Completes with r or a copy of r, unless already completed.
344 * If exceptional, r is first coerced to a CompletionException.
345 */
346 final boolean completeRelay(Object r) {
347 return RESULT.compareAndSet(this, null, encodeRelay(r));
348 }
349
350 /**
351 * Reports result using Future.get conventions.
352 */
353 private static Object reportGet(Object r)
354 throws InterruptedException, ExecutionException {
355 if (r == null) // by convention below, null means interrupted
356 throw new InterruptedException();
357 if (r instanceof AltResult) {
358 Throwable x, cause;
359 if ((x = ((AltResult)r).ex) == null)
360 return null;
361 if (x instanceof CancellationException)
362 throw (CancellationException)x;
363 if ((x instanceof CompletionException) &&
364 (cause = x.getCause()) != null)
365 x = cause;
366 throw new ExecutionException(x);
367 }
368 return r;
369 }
370
371 /**
372 * Decodes outcome to return result or throw unchecked exception.
373 */
374 private static Object reportJoin(Object r) {
375 if (r instanceof AltResult) {
376 Throwable x;
377 if ((x = ((AltResult)r).ex) == null)
378 return null;
379 if (x instanceof CancellationException)
380 throw (CancellationException)x;
381 if (x instanceof CompletionException)
382 throw (CompletionException)x;
383 throw new CompletionException(x);
384 }
385 return r;
386 }
387
388 /* ------------- Async task preliminaries -------------- */
389
390 /**
391 * A marker interface identifying asynchronous tasks produced by
392 * {@code async} methods. This may be useful for monitoring,
393 * debugging, and tracking asynchronous activities.
394 *
395 * @since 1.8
396 */
397 public static interface AsynchronousCompletionTask {
398 }
399
400 private static final boolean USE_COMMON_POOL =
401 (ForkJoinPool.getCommonPoolParallelism() > 1);
402
403 /**
404 * Default executor -- ForkJoinPool.commonPool() unless it cannot
405 * support parallelism.
406 */
407 private static final Executor ASYNC_POOL = USE_COMMON_POOL ?
408 ForkJoinPool.commonPool() : new ThreadPerTaskExecutor();
409
410 /** Fallback if ForkJoinPool.commonPool() cannot support parallelism */
411 static final class ThreadPerTaskExecutor implements Executor {
412 public void execute(Runnable r) { new Thread(r).start(); }
413 }
414
415 /**
416 * Null-checks user executor argument, and translates uses of
417 * commonPool to ASYNC_POOL in case parallelism disabled.
418 */
419 static Executor screenExecutor(Executor e) {
420 if (!USE_COMMON_POOL && e == ForkJoinPool.commonPool())
421 return ASYNC_POOL;
422 if (e == null) throw new NullPointerException();
423 return e;
424 }
425
426 // Modes for Completion.tryFire. Signedness matters.
427 static final int SYNC = 0;
428 static final int ASYNC = 1;
429 static final int NESTED = -1;
430
431 /* ------------- Base Completion classes and operations -------------- */
432
433 @SuppressWarnings("serial")
434 abstract static class Completion extends ForkJoinTask<Void>
435 implements Runnable, AsynchronousCompletionTask {
436 volatile Completion next; // Treiber stack link
437
438 /**
439 * Performs completion action if triggered, returning a
440 * dependent that may need propagation, if one exists.
441 *
442 * @param mode SYNC, ASYNC, or NESTED
443 */
444 abstract CompletableFuture<?> tryFire(int mode);
445
446 /** Returns true if possibly still triggerable. Used by cleanStack. */
447 abstract boolean isLive();
448
449 public final void run() { tryFire(ASYNC); }
450 public final boolean exec() { tryFire(ASYNC); return false; }
451 public final Void getRawResult() { return null; }
452 public final void setRawResult(Void v) {}
453 }
454
455 /**
456 * Pops and tries to trigger all reachable dependents. Call only
457 * when known to be done.
458 */
459 final void postComplete() {
460 /*
461 * On each step, variable f holds current dependents to pop
462 * and run. It is extended along only one path at a time,
463 * pushing others to avoid unbounded recursion.
464 */
465 CompletableFuture<?> f = this; Completion h;
466 while ((h = f.stack) != null ||
467 (f != this && (h = (f = this).stack) != null)) {
468 CompletableFuture<?> d; Completion t;
469 if (STACK.compareAndSet(f, h, t = h.next)) {
470 if (t != null) {
471 if (f != this) {
472 pushStack(h);
473 continue;
474 }
475 NEXT.compareAndSet(h, t, null); // try to detach
476 }
477 f = (d = h.tryFire(NESTED)) == null ? this : d;
478 }
479 }
480 }
481
482 /** Traverses stack and unlinks one or more dead Completions, if found. */
483 final void cleanStack() {
484 Completion p = stack;
485 // ensure head of stack live
486 for (boolean unlinked = false;;) {
487 if (p == null)
488 return;
489 else if (p.isLive()) {
490 if (unlinked)
491 return;
492 else
493 break;
494 }
495 else if (STACK.weakCompareAndSet(this, p, (p = p.next)))
496 unlinked = true;
497 else
498 p = stack;
499 }
500 // try to unlink first non-live
501 for (Completion q = p.next; q != null;) {
502 Completion s = q.next;
503 if (q.isLive()) {
504 p = q;
505 q = s;
506 } else if (NEXT.weakCompareAndSet(p, q, s))
507 break;
508 else
509 q = p.next;
510 }
511 }
512
513 /* ------------- One-input Completions -------------- */
514
515 /** A Completion with a source, dependent, and executor. */
516 @SuppressWarnings("serial")
517 abstract static class UniCompletion<T,V> extends Completion {
518 Executor executor; // executor to use (null if none)
519 CompletableFuture<V> dep; // the dependent to complete
520 CompletableFuture<T> src; // source for action
521
522 UniCompletion(Executor executor, CompletableFuture<V> dep,
523 CompletableFuture<T> src) {
524 this.executor = executor; this.dep = dep; this.src = src;
525 }
526
527 /**
528 * Returns true if action can be run. Call only when known to
529 * be triggerable. Uses FJ tag bit to ensure that only one
530 * thread claims ownership. If async, starts as task -- a
531 * later call to tryFire will run action.
532 */
533 final boolean claim() {
534 Executor e = executor;
535 if (compareAndSetForkJoinTaskTag((short)0, (short)1)) {
536 if (e == null)
537 return true;
538 executor = null; // disable
539 e.execute(this);
540 }
541 return false;
542 }
543
544 final boolean isLive() { return dep != null; }
545 }
546
547 /**
548 * Pushes the given completion unless it completes while trying.
549 * Caller should first check that result is null.
550 */
551 final void unipush(Completion c) {
552 if (c != null) {
553 while (!tryPushStack(c)) {
554 if (result != null) {
555 NEXT.set(c, null);
556 break;
557 }
558 }
559 if (result != null)
560 c.tryFire(SYNC);
561 }
562 }
563
564 /**
565 * Post-processing by dependent after successful UniCompletion tryFire.
566 * Tries to clean stack of source a, and then either runs postComplete
567 * or returns this to caller, depending on mode.
568 */
569 final CompletableFuture<T> postFire(CompletableFuture<?> a, int mode) {
570 if (a != null && a.stack != null) {
571 Object r;
572 if ((r = a.result) == null)
573 a.cleanStack();
574 if (mode >= 0 && (r != null || a.result != null))
575 a.postComplete();
576 }
577 if (result != null && stack != null) {
578 if (mode < 0)
579 return this;
580 else
581 postComplete();
582 }
583 return null;
584 }
585
586 @SuppressWarnings("serial")
587 static final class UniApply<T,V> extends UniCompletion<T,V> {
588 Function<? super T,? extends V> fn;
589 UniApply(Executor executor, CompletableFuture<V> dep,
590 CompletableFuture<T> src,
591 Function<? super T,? extends V> fn) {
592 super(executor, dep, src); this.fn = fn;
593 }
594 final CompletableFuture<V> tryFire(int mode) {
595 CompletableFuture<V> d; CompletableFuture<T> a;
596 Object r; Throwable x; Function<? super T,? extends V> f;
597 if ((d = dep) == null || (f = fn) == null
598 || (a = src) == null || (r = a.result) == null)
599 return null;
600 tryComplete: if (d.result == null) {
601 if (r instanceof AltResult) {
602 if ((x = ((AltResult)r).ex) != null) {
603 d.completeThrowable(x, r);
604 break tryComplete;
605 }
606 r = null;
607 }
608 try {
609 if (mode <= 0 && !claim())
610 return null;
611 else {
612 @SuppressWarnings("unchecked") T t = (T) r;
613 d.completeValue(f.apply(t));
614 }
615 } catch (Throwable ex) {
616 d.completeThrowable(ex);
617 }
618 }
619 dep = null; src = null; fn = null;
620 return d.postFire(a, mode);
621 }
622 }
623
624 private <V> CompletableFuture<V> uniApplyStage(
625 Executor e, Function<? super T,? extends V> f) {
626 if (f == null) throw new NullPointerException();
627 Object r;
628 if ((r = result) != null)
629 return uniApplyNow(r, e, f);
630 CompletableFuture<V> d = newIncompleteFuture();
631 unipush(new UniApply<T,V>(e, d, this, f));
632 return d;
633 }
634
635 private <V> CompletableFuture<V> uniApplyNow(
636 Object r, Executor e, Function<? super T,? extends V> f) {
637 Throwable x;
638 CompletableFuture<V> d = newIncompleteFuture();
639 if (r instanceof AltResult) {
640 if ((x = ((AltResult)r).ex) != null) {
641 d.result = encodeThrowable(x, r);
642 return d;
643 }
644 r = null;
645 }
646 try {
647 if (e != null) {
648 e.execute(new UniApply<T,V>(null, d, this, f));
649 } else {
650 @SuppressWarnings("unchecked") T t = (T) r;
651 d.result = d.encodeValue(f.apply(t));
652 }
653 } catch (Throwable ex) {
654 d.result = encodeThrowable(ex);
655 }
656 return d;
657 }
658
659 @SuppressWarnings("serial")
660 static final class UniAccept<T> extends UniCompletion<T,Void> {
661 Consumer<? super T> fn;
662 UniAccept(Executor executor, CompletableFuture<Void> dep,
663 CompletableFuture<T> src, Consumer<? super T> fn) {
664 super(executor, dep, src); this.fn = fn;
665 }
666 final CompletableFuture<Void> tryFire(int mode) {
667 CompletableFuture<Void> d; CompletableFuture<T> a;
668 Object r; Throwable x; Consumer<? super T> f;
669 if ((d = dep) == null || (f = fn) == null
670 || (a = src) == null || (r = a.result) == null)
671 return null;
672 tryComplete: if (d.result == null) {
673 if (r instanceof AltResult) {
674 if ((x = ((AltResult)r).ex) != null) {
675 d.completeThrowable(x, r);
676 break tryComplete;
677 }
678 r = null;
679 }
680 try {
681 if (mode <= 0 && !claim())
682 return null;
683 else {
684 @SuppressWarnings("unchecked") T t = (T) r;
685 f.accept(t);
686 d.completeNull();
687 }
688 } catch (Throwable ex) {
689 d.completeThrowable(ex);
690 }
691 }
692 dep = null; src = null; fn = null;
693 return d.postFire(a, mode);
694 }
695 }
696
697 private CompletableFuture<Void> uniAcceptStage(Executor e,
698 Consumer<? super T> f) {
699 if (f == null) throw new NullPointerException();
700 Object r;
701 if ((r = result) != null)
702 return uniAcceptNow(r, e, f);
703 CompletableFuture<Void> d = newIncompleteFuture();
704 unipush(new UniAccept<T>(e, d, this, f));
705 return d;
706 }
707
708 private CompletableFuture<Void> uniAcceptNow(
709 Object r, Executor e, Consumer<? super T> f) {
710 Throwable x;
711 CompletableFuture<Void> d = newIncompleteFuture();
712 if (r instanceof AltResult) {
713 if ((x = ((AltResult)r).ex) != null) {
714 d.result = encodeThrowable(x, r);
715 return d;
716 }
717 r = null;
718 }
719 try {
720 if (e != null) {
721 e.execute(new UniAccept<T>(null, d, this, f));
722 } else {
723 @SuppressWarnings("unchecked") T t = (T) r;
724 f.accept(t);
725 d.result = NIL;
726 }
727 } catch (Throwable ex) {
728 d.result = encodeThrowable(ex);
729 }
730 return d;
731 }
732
733 @SuppressWarnings("serial")
734 static final class UniRun<T> extends UniCompletion<T,Void> {
735 Runnable fn;
736 UniRun(Executor executor, CompletableFuture<Void> dep,
737 CompletableFuture<T> src, Runnable fn) {
738 super(executor, dep, src); this.fn = fn;
739 }
740 final CompletableFuture<Void> tryFire(int mode) {
741 CompletableFuture<Void> d; CompletableFuture<T> a;
742 Object r; Throwable x; Runnable f;
743 if ((d = dep) == null || (f = fn) == null
744 || (a = src) == null || (r = a.result) == null)
745 return null;
746 if (d.result == null) {
747 if (r instanceof AltResult && (x = ((AltResult)r).ex) != null)
748 d.completeThrowable(x, r);
749 else
750 try {
751 if (mode <= 0 && !claim())
752 return null;
753 else {
754 f.run();
755 d.completeNull();
756 }
757 } catch (Throwable ex) {
758 d.completeThrowable(ex);
759 }
760 }
761 dep = null; src = null; fn = null;
762 return d.postFire(a, mode);
763 }
764 }
765
766 private CompletableFuture<Void> uniRunStage(Executor e, Runnable f) {
767 if (f == null) throw new NullPointerException();
768 Object r;
769 if ((r = result) != null)
770 return uniRunNow(r, e, f);
771 CompletableFuture<Void> d = newIncompleteFuture();
772 unipush(new UniRun<T>(e, d, this, f));
773 return d;
774 }
775
776 private CompletableFuture<Void> uniRunNow(Object r, Executor e, Runnable f) {
777 Throwable x;
778 CompletableFuture<Void> d = newIncompleteFuture();
779 if (r instanceof AltResult && (x = ((AltResult)r).ex) != null)
780 d.result = encodeThrowable(x, r);
781 else
782 try {
783 if (e != null) {
784 e.execute(new UniRun<T>(null, d, this, f));
785 } else {
786 f.run();
787 d.result = NIL;
788 }
789 } catch (Throwable ex) {
790 d.result = encodeThrowable(ex);
791 }
792 return d;
793 }
794
795 @SuppressWarnings("serial")
796 static final class UniWhenComplete<T> extends UniCompletion<T,T> {
797 BiConsumer<? super T, ? super Throwable> fn;
798 UniWhenComplete(Executor executor, CompletableFuture<T> dep,
799 CompletableFuture<T> src,
800 BiConsumer<? super T, ? super Throwable> fn) {
801 super(executor, dep, src); this.fn = fn;
802 }
803 final CompletableFuture<T> tryFire(int mode) {
804 CompletableFuture<T> d; CompletableFuture<T> a;
805 Object r; BiConsumer<? super T, ? super Throwable> f;
806 if ((d = dep) == null || (f = fn) == null
807 || (a = src) == null || (r = a.result) == null
808 || !d.uniWhenComplete(r, f, mode > 0 ? null : this))
809 return null;
810 dep = null; src = null; fn = null;
811 return d.postFire(a, mode);
812 }
813 }
814
815 final boolean uniWhenComplete(Object r,
816 BiConsumer<? super T,? super Throwable> f,
817 UniWhenComplete<T> c) {
818 T t; Throwable x = null;
819 if (result == null) {
820 try {
821 if (c != null && !c.claim())
822 return false;
823 if (r instanceof AltResult) {
824 x = ((AltResult)r).ex;
825 t = null;
826 } else {
827 @SuppressWarnings("unchecked") T tr = (T) r;
828 t = tr;
829 }
830 f.accept(t, x);
831 if (x == null) {
832 internalComplete(r);
833 return true;
834 }
835 } catch (Throwable ex) {
836 if (x == null)
837 x = ex;
838 else if (x != ex)
839 x.addSuppressed(ex);
840 }
841 completeThrowable(x, r);
842 }
843 return true;
844 }
845
846 private CompletableFuture<T> uniWhenCompleteStage(
847 Executor e, BiConsumer<? super T, ? super Throwable> f) {
848 if (f == null) throw new NullPointerException();
849 CompletableFuture<T> d = newIncompleteFuture();
850 Object r;
851 if ((r = result) == null)
852 unipush(new UniWhenComplete<T>(e, d, this, f));
853 else if (e == null)
854 d.uniWhenComplete(r, f, null);
855 else {
856 try {
857 e.execute(new UniWhenComplete<T>(null, d, this, f));
858 } catch (Throwable ex) {
859 d.result = encodeThrowable(ex);
860 }
861 }
862 return d;
863 }
864
865 @SuppressWarnings("serial")
866 static final class UniHandle<T,V> extends UniCompletion<T,V> {
867 BiFunction<? super T, Throwable, ? extends V> fn;
868 UniHandle(Executor executor, CompletableFuture<V> dep,
869 CompletableFuture<T> src,
870 BiFunction<? super T, Throwable, ? extends V> fn) {
871 super(executor, dep, src); this.fn = fn;
872 }
873 final CompletableFuture<V> tryFire(int mode) {
874 CompletableFuture<V> d; CompletableFuture<T> a;
875 Object r; BiFunction<? super T, Throwable, ? extends V> f;
876 if ((d = dep) == null || (f = fn) == null
877 || (a = src) == null || (r = a.result) == null
878 || !d.uniHandle(r, f, mode > 0 ? null : this))
879 return null;
880 dep = null; src = null; fn = null;
881 return d.postFire(a, mode);
882 }
883 }
884
885 final <S> boolean uniHandle(Object r,
886 BiFunction<? super S, Throwable, ? extends T> f,
887 UniHandle<S,T> c) {
888 S s; Throwable x;
889 if (result == null) {
890 try {
891 if (c != null && !c.claim())
892 return false;
893 if (r instanceof AltResult) {
894 x = ((AltResult)r).ex;
895 s = null;
896 } else {
897 x = null;
898 @SuppressWarnings("unchecked") S ss = (S) r;
899 s = ss;
900 }
901 completeValue(f.apply(s, x));
902 } catch (Throwable ex) {
903 completeThrowable(ex);
904 }
905 }
906 return true;
907 }
908
909 private <V> CompletableFuture<V> uniHandleStage(
910 Executor e, BiFunction<? super T, Throwable, ? extends V> f) {
911 if (f == null) throw new NullPointerException();
912 CompletableFuture<V> d = newIncompleteFuture();
913 Object r;
914 if ((r = result) == null)
915 unipush(new UniHandle<T,V>(e, d, this, f));
916 else if (e == null)
917 d.uniHandle(r, f, null);
918 else {
919 try {
920 e.execute(new UniHandle<T,V>(null, d, this, f));
921 } catch (Throwable ex) {
922 d.result = encodeThrowable(ex);
923 }
924 }
925 return d;
926 }
927
928 @SuppressWarnings("serial")
929 static final class UniExceptionally<T> extends UniCompletion<T,T> {
930 Function<? super Throwable, ? extends T> fn;
931 UniExceptionally(Executor executor,
932 CompletableFuture<T> dep, CompletableFuture<T> src,
933 Function<? super Throwable, ? extends T> fn) {
934 super(executor, dep, src); this.fn = fn;
935 }
936 final CompletableFuture<T> tryFire(int mode) {
937 CompletableFuture<T> d; CompletableFuture<T> a;
938 Object r; Function<? super Throwable, ? extends T> f;
939 if ((d = dep) == null || (f = fn) == null
940 || (a = src) == null || (r = a.result) == null
941 || !d.uniExceptionally(r, f, mode > 0 ? null : this))
942 return null;
943 dep = null; src = null; fn = null;
944 return d.postFire(a, mode);
945 }
946 }
947
948 final boolean uniExceptionally(Object r,
949 Function<? super Throwable, ? extends T> f,
950 UniExceptionally<T> c) {
951 Throwable x;
952 if (result == null) {
953 try {
954 if (c != null && !c.claim())
955 return false;
956 if (r instanceof AltResult && (x = ((AltResult)r).ex) != null)
957 completeValue(f.apply(x));
958 else
959 internalComplete(r);
960 } catch (Throwable ex) {
961 completeThrowable(ex);
962 }
963 }
964 return true;
965 }
966
967 private CompletableFuture<T> uniExceptionallyStage(
968 Executor e, Function<Throwable, ? extends T> f) {
969 if (f == null) throw new NullPointerException();
970 CompletableFuture<T> d = newIncompleteFuture();
971 Object r;
972 if ((r = result) == null)
973 unipush(new UniExceptionally<T>(e, d, this, f));
974 else if (e == null)
975 d.uniExceptionally(r, f, null);
976 else {
977 try {
978 e.execute(new UniExceptionally<T>(null, d, this, f));
979 } catch (Throwable ex) {
980 d.result = encodeThrowable(ex);
981 }
982 }
983 return d;
984 }
985
986 @SuppressWarnings("serial")
987 static final class UniComposeExceptionally<T> extends UniCompletion<T,T> {
988 Function<Throwable, ? extends CompletionStage<T>> fn;
989 UniComposeExceptionally(Executor executor, CompletableFuture<T> dep,
990 CompletableFuture<T> src,
991 Function<Throwable, ? extends CompletionStage<T>> fn) {
992 super(executor, dep, src); this.fn = fn;
993 }
994 final CompletableFuture<T> tryFire(int mode) {
995 CompletableFuture<T> d; CompletableFuture<T> a;
996 Function<Throwable, ? extends CompletionStage<T>> f;
997 Object r; Throwable x;
998 if ((d = dep) == null || (f = fn) == null
999 || (a = src) == null || (r = a.result) == null)
1000 return null;
1001 if (d.result == null) {
1002 if ((r instanceof AltResult) &&
1003 (x = ((AltResult)r).ex) != null) {
1004 try {
1005 if (mode <= 0 && !claim())
1006 return null;
1007 CompletableFuture<T> g = f.apply(x).toCompletableFuture();
1008 if ((r = g.result) != null)
1009 d.completeRelay(r);
1010 else {
1011 g.unipush(new UniRelay<T,T>(d, g));
1012 if (d.result == null)
1013 return null;
1014 }
1015 } catch (Throwable ex) {
1016 d.completeThrowable(ex);
1017 }
1018 }
1019 else
1020 d.internalComplete(r);
1021 }
1022 dep = null; src = null; fn = null;
1023 return d.postFire(a, mode);
1024 }
1025 }
1026
1027 private CompletableFuture<T> uniComposeExceptionallyStage(
1028 Executor e, Function<Throwable, ? extends CompletionStage<T>> f) {
1029 if (f == null) throw new NullPointerException();
1030 final CompletableFuture<T> d;
1031 Object r; Throwable x;
1032 if ((r = result) == null)
1033 unipush(new UniComposeExceptionally<T>(
1034 e, d = newIncompleteFuture(), this, f));
1035 else if (!(r instanceof AltResult) || (x = ((AltResult)r).ex) == null)
1036 return this;
1037 else
1038 try {
1039 if (e == null)
1040 return f.apply(x).toCompletableFuture();
1041 else
1042 e.execute(new UniComposeExceptionally<T>(
1043 null, d = newIncompleteFuture(), this, f));
1044 } catch (Throwable ex) {
1045 return new CompletableFuture<T>(encodeThrowable(ex));
1046 }
1047 return d;
1048 }
1049
1050 @SuppressWarnings("serial")
1051 static final class UniRelay<U, T extends U> extends UniCompletion<T,U> {
1052 UniRelay(CompletableFuture<U> dep, CompletableFuture<T> src) {
1053 super(null, dep, src);
1054 }
1055 final CompletableFuture<U> tryFire(int mode) {
1056 CompletableFuture<U> d; CompletableFuture<T> a; Object r;
1057 if ((d = dep) == null
1058 || (a = src) == null || (r = a.result) == null)
1059 return null;
1060 if (d.result == null)
1061 d.completeRelay(r);
1062 src = null; dep = null;
1063 return d.postFire(a, mode);
1064 }
1065 }
1066
1067 private static <U, T extends U> CompletableFuture<U> uniCopyStage(
1068 CompletableFuture<T> src) {
1069 Object r;
1070 CompletableFuture<U> d = src.newIncompleteFuture();
1071 if ((r = src.result) != null)
1072 d.result = encodeRelay(r);
1073 else
1074 src.unipush(new UniRelay<U,T>(d, src));
1075 return d;
1076 }
1077
1078 private MinimalStage<T> uniAsMinimalStage() {
1079 Object r;
1080 if ((r = result) != null)
1081 return new MinimalStage<T>(encodeRelay(r));
1082 MinimalStage<T> d = new MinimalStage<T>();
1083 unipush(new UniRelay<T,T>(d, this));
1084 return d;
1085 }
1086
1087 @SuppressWarnings("serial")
1088 static final class UniCompose<T,V> extends UniCompletion<T,V> {
1089 Function<? super T, ? extends CompletionStage<V>> fn;
1090 UniCompose(Executor executor, CompletableFuture<V> dep,
1091 CompletableFuture<T> src,
1092 Function<? super T, ? extends CompletionStage<V>> fn) {
1093 super(executor, dep, src); this.fn = fn;
1094 }
1095 final CompletableFuture<V> tryFire(int mode) {
1096 CompletableFuture<V> d; CompletableFuture<T> a;
1097 Function<? super T, ? extends CompletionStage<V>> f;
1098 Object r; Throwable x;
1099 if ((d = dep) == null || (f = fn) == null
1100 || (a = src) == null || (r = a.result) == null)
1101 return null;
1102 tryComplete: if (d.result == null) {
1103 if (r instanceof AltResult) {
1104 if ((x = ((AltResult)r).ex) != null) {
1105 d.completeThrowable(x, r);
1106 break tryComplete;
1107 }
1108 r = null;
1109 }
1110 try {
1111 if (mode <= 0 && !claim())
1112 return null;
1113 @SuppressWarnings("unchecked") T t = (T) r;
1114 CompletableFuture<V> g = f.apply(t).toCompletableFuture();
1115 if ((r = g.result) != null)
1116 d.completeRelay(r);
1117 else {
1118 g.unipush(new UniRelay<V,V>(d, g));
1119 if (d.result == null)
1120 return null;
1121 }
1122 } catch (Throwable ex) {
1123 d.completeThrowable(ex);
1124 }
1125 }
1126 dep = null; src = null; fn = null;
1127 return d.postFire(a, mode);
1128 }
1129 }
1130
1131 private <V> CompletableFuture<V> uniComposeStage(
1132 Executor e, Function<? super T, ? extends CompletionStage<V>> f) {
1133 if (f == null) throw new NullPointerException();
1134 CompletableFuture<V> d = newIncompleteFuture();
1135 Object r, s; Throwable x;
1136 if ((r = result) == null)
1137 unipush(new UniCompose<T,V>(e, d, this, f));
1138 else if (e == null) {
1139 if (r instanceof AltResult) {
1140 if ((x = ((AltResult)r).ex) != null) {
1141 d.result = encodeThrowable(x, r);
1142 return d;
1143 }
1144 r = null;
1145 }
1146 try {
1147 @SuppressWarnings("unchecked") T t = (T) r;
1148 CompletableFuture<V> g = f.apply(t).toCompletableFuture();
1149 if ((s = g.result) != null)
1150 d.result = encodeRelay(s);
1151 else {
1152 g.unipush(new UniRelay<V,V>(d, g));
1153 }
1154 } catch (Throwable ex) {
1155 d.result = encodeThrowable(ex);
1156 }
1157 }
1158 else
1159 try {
1160 e.execute(new UniCompose<T,V>(null, d, this, f));
1161 } catch (Throwable ex) {
1162 d.result = encodeThrowable(ex);
1163 }
1164 return d;
1165 }
1166
1167 /* ------------- Two-input Completions -------------- */
1168
1169 /** A Completion for an action with two sources */
1170 @SuppressWarnings("serial")
1171 abstract static class BiCompletion<T,U,V> extends UniCompletion<T,V> {
1172 CompletableFuture<U> snd; // second source for action
1173 BiCompletion(Executor executor, CompletableFuture<V> dep,
1174 CompletableFuture<T> src, CompletableFuture<U> snd) {
1175 super(executor, dep, src); this.snd = snd;
1176 }
1177 }
1178
1179 /** A Completion delegating to a BiCompletion */
1180 @SuppressWarnings("serial")
1181 static final class CoCompletion extends Completion {
1182 BiCompletion<?,?,?> base;
1183 CoCompletion(BiCompletion<?,?,?> base) { this.base = base; }
1184 final CompletableFuture<?> tryFire(int mode) {
1185 BiCompletion<?,?,?> c; CompletableFuture<?> d;
1186 if ((c = base) == null || (d = c.tryFire(mode)) == null)
1187 return null;
1188 base = null; // detach
1189 return d;
1190 }
1191 final boolean isLive() {
1192 BiCompletion<?,?,?> c;
1193 return (c = base) != null
1194 // && c.isLive()
1195 && c.dep != null;
1196 }
1197 }
1198
1199 /**
1200 * Pushes completion to this and b unless both done.
1201 * Caller should first check that either result or b.result is null.
1202 */
1203 final void bipush(CompletableFuture<?> b, BiCompletion<?,?,?> c) {
1204 if (c != null) {
1205 while (result == null) {
1206 if (tryPushStack(c)) {
1207 if (b.result == null)
1208 b.unipush(new CoCompletion(c));
1209 else if (result != null)
1210 c.tryFire(SYNC);
1211 return;
1212 }
1213 }
1214 b.unipush(c);
1215 }
1216 }
1217
1218 /** Post-processing after successful BiCompletion tryFire. */
1219 final CompletableFuture<T> postFire(CompletableFuture<?> a,
1220 CompletableFuture<?> b, int mode) {
1221 if (b != null && b.stack != null) { // clean second source
1222 Object r;
1223 if ((r = b.result) == null)
1224 b.cleanStack();
1225 if (mode >= 0 && (r != null || b.result != null))
1226 b.postComplete();
1227 }
1228 return postFire(a, mode);
1229 }
1230
1231 @SuppressWarnings("serial")
1232 static final class BiApply<T,U,V> extends BiCompletion<T,U,V> {
1233 BiFunction<? super T,? super U,? extends V> fn;
1234 BiApply(Executor executor, CompletableFuture<V> dep,
1235 CompletableFuture<T> src, CompletableFuture<U> snd,
1236 BiFunction<? super T,? super U,? extends V> fn) {
1237 super(executor, dep, src, snd); this.fn = fn;
1238 }
1239 final CompletableFuture<V> tryFire(int mode) {
1240 CompletableFuture<V> d;
1241 CompletableFuture<T> a;
1242 CompletableFuture<U> b;
1243 Object r, s; BiFunction<? super T,? super U,? extends V> f;
1244 if ((d = dep) == null || (f = fn) == null
1245 || (a = src) == null || (r = a.result) == null
1246 || (b = snd) == null || (s = b.result) == null
1247 || !d.biApply(r, s, f, mode > 0 ? null : this))
1248 return null;
1249 dep = null; src = null; snd = null; fn = null;
1250 return d.postFire(a, b, mode);
1251 }
1252 }
1253
1254 final <R,S> boolean biApply(Object r, Object s,
1255 BiFunction<? super R,? super S,? extends T> f,
1256 BiApply<R,S,T> c) {
1257 Throwable x;
1258 tryComplete: if (result == null) {
1259 if (r instanceof AltResult) {
1260 if ((x = ((AltResult)r).ex) != null) {
1261 completeThrowable(x, r);
1262 break tryComplete;
1263 }
1264 r = null;
1265 }
1266 if (s instanceof AltResult) {
1267 if ((x = ((AltResult)s).ex) != null) {
1268 completeThrowable(x, s);
1269 break tryComplete;
1270 }
1271 s = null;
1272 }
1273 try {
1274 if (c != null && !c.claim())
1275 return false;
1276 @SuppressWarnings("unchecked") R rr = (R) r;
1277 @SuppressWarnings("unchecked") S ss = (S) s;
1278 completeValue(f.apply(rr, ss));
1279 } catch (Throwable ex) {
1280 completeThrowable(ex);
1281 }
1282 }
1283 return true;
1284 }
1285
1286 private <U,V> CompletableFuture<V> biApplyStage(
1287 Executor e, CompletionStage<U> o,
1288 BiFunction<? super T,? super U,? extends V> f) {
1289 CompletableFuture<U> b; Object r, s;
1290 if (f == null || (b = o.toCompletableFuture()) == null)
1291 throw new NullPointerException();
1292 CompletableFuture<V> d = newIncompleteFuture();
1293 if ((r = result) == null || (s = b.result) == null)
1294 bipush(b, new BiApply<T,U,V>(e, d, this, b, f));
1295 else if (e == null)
1296 d.biApply(r, s, f, null);
1297 else
1298 try {
1299 e.execute(new BiApply<T,U,V>(null, d, this, b, f));
1300 } catch (Throwable ex) {
1301 d.result = encodeThrowable(ex);
1302 }
1303 return d;
1304 }
1305
1306 @SuppressWarnings("serial")
1307 static final class BiAccept<T,U> extends BiCompletion<T,U,Void> {
1308 BiConsumer<? super T,? super U> fn;
1309 BiAccept(Executor executor, CompletableFuture<Void> dep,
1310 CompletableFuture<T> src, CompletableFuture<U> snd,
1311 BiConsumer<? super T,? super U> fn) {
1312 super(executor, dep, src, snd); this.fn = fn;
1313 }
1314 final CompletableFuture<Void> tryFire(int mode) {
1315 CompletableFuture<Void> d;
1316 CompletableFuture<T> a;
1317 CompletableFuture<U> b;
1318 Object r, s; BiConsumer<? super T,? super U> f;
1319 if ((d = dep) == null || (f = fn) == null
1320 || (a = src) == null || (r = a.result) == null
1321 || (b = snd) == null || (s = b.result) == null
1322 || !d.biAccept(r, s, f, mode > 0 ? null : this))
1323 return null;
1324 dep = null; src = null; snd = null; fn = null;
1325 return d.postFire(a, b, mode);
1326 }
1327 }
1328
1329 final <R,S> boolean biAccept(Object r, Object s,
1330 BiConsumer<? super R,? super S> f,
1331 BiAccept<R,S> c) {
1332 Throwable x;
1333 tryComplete: if (result == null) {
1334 if (r instanceof AltResult) {
1335 if ((x = ((AltResult)r).ex) != null) {
1336 completeThrowable(x, r);
1337 break tryComplete;
1338 }
1339 r = null;
1340 }
1341 if (s instanceof AltResult) {
1342 if ((x = ((AltResult)s).ex) != null) {
1343 completeThrowable(x, s);
1344 break tryComplete;
1345 }
1346 s = null;
1347 }
1348 try {
1349 if (c != null && !c.claim())
1350 return false;
1351 @SuppressWarnings("unchecked") R rr = (R) r;
1352 @SuppressWarnings("unchecked") S ss = (S) s;
1353 f.accept(rr, ss);
1354 completeNull();
1355 } catch (Throwable ex) {
1356 completeThrowable(ex);
1357 }
1358 }
1359 return true;
1360 }
1361
1362 private <U> CompletableFuture<Void> biAcceptStage(
1363 Executor e, CompletionStage<U> o,
1364 BiConsumer<? super T,? super U> f) {
1365 CompletableFuture<U> b; Object r, s;
1366 if (f == null || (b = o.toCompletableFuture()) == null)
1367 throw new NullPointerException();
1368 CompletableFuture<Void> d = newIncompleteFuture();
1369 if ((r = result) == null || (s = b.result) == null)
1370 bipush(b, new BiAccept<T,U>(e, d, this, b, f));
1371 else if (e == null)
1372 d.biAccept(r, s, f, null);
1373 else
1374 try {
1375 e.execute(new BiAccept<T,U>(null, d, this, b, f));
1376 } catch (Throwable ex) {
1377 d.result = encodeThrowable(ex);
1378 }
1379 return d;
1380 }
1381
1382 @SuppressWarnings("serial")
1383 static final class BiRun<T,U> extends BiCompletion<T,U,Void> {
1384 Runnable fn;
1385 BiRun(Executor executor, CompletableFuture<Void> dep,
1386 CompletableFuture<T> src, CompletableFuture<U> snd,
1387 Runnable fn) {
1388 super(executor, dep, src, snd); this.fn = fn;
1389 }
1390 final CompletableFuture<Void> tryFire(int mode) {
1391 CompletableFuture<Void> d;
1392 CompletableFuture<T> a;
1393 CompletableFuture<U> b;
1394 Object r, s; Runnable f;
1395 if ((d = dep) == null || (f = fn) == null
1396 || (a = src) == null || (r = a.result) == null
1397 || (b = snd) == null || (s = b.result) == null
1398 || !d.biRun(r, s, f, mode > 0 ? null : this))
1399 return null;
1400 dep = null; src = null; snd = null; fn = null;
1401 return d.postFire(a, b, mode);
1402 }
1403 }
1404
1405 final boolean biRun(Object r, Object s, Runnable f, BiRun<?,?> c) {
1406 Throwable x; Object z;
1407 if (result == null) {
1408 if ((r instanceof AltResult
1409 && (x = ((AltResult)(z = r)).ex) != null) ||
1410 (s instanceof AltResult
1411 && (x = ((AltResult)(z = s)).ex) != null))
1412 completeThrowable(x, z);
1413 else
1414 try {
1415 if (c != null && !c.claim())
1416 return false;
1417 f.run();
1418 completeNull();
1419 } catch (Throwable ex) {
1420 completeThrowable(ex);
1421 }
1422 }
1423 return true;
1424 }
1425
1426 private CompletableFuture<Void> biRunStage(Executor e, CompletionStage<?> o,
1427 Runnable f) {
1428 CompletableFuture<?> b; Object r, s;
1429 if (f == null || (b = o.toCompletableFuture()) == null)
1430 throw new NullPointerException();
1431 CompletableFuture<Void> d = newIncompleteFuture();
1432 if ((r = result) == null || (s = b.result) == null)
1433 bipush(b, new BiRun<>(e, d, this, b, f));
1434 else if (e == null)
1435 d.biRun(r, s, f, null);
1436 else
1437 try {
1438 e.execute(new BiRun<>(null, d, this, b, f));
1439 } catch (Throwable ex) {
1440 d.result = encodeThrowable(ex);
1441 }
1442 return d;
1443 }
1444
1445 @SuppressWarnings("serial")
1446 static final class BiRelay<T,U> extends BiCompletion<T,U,Void> { // for And
1447 BiRelay(CompletableFuture<Void> dep,
1448 CompletableFuture<T> src, CompletableFuture<U> snd) {
1449 super(null, dep, src, snd);
1450 }
1451 final CompletableFuture<Void> tryFire(int mode) {
1452 CompletableFuture<Void> d;
1453 CompletableFuture<T> a;
1454 CompletableFuture<U> b;
1455 Object r, s, z; Throwable x;
1456 if ((d = dep) == null
1457 || (a = src) == null || (r = a.result) == null
1458 || (b = snd) == null || (s = b.result) == null)
1459 return null;
1460 if (d.result == null) {
1461 if ((r instanceof AltResult
1462 && (x = ((AltResult)(z = r)).ex) != null) ||
1463 (s instanceof AltResult
1464 && (x = ((AltResult)(z = s)).ex) != null))
1465 d.completeThrowable(x, z);
1466 else
1467 d.completeNull();
1468 }
1469 src = null; snd = null; dep = null;
1470 return d.postFire(a, b, mode);
1471 }
1472 }
1473
1474 /** Recursively constructs a tree of completions. */
1475 static CompletableFuture<Void> andTree(CompletableFuture<?>[] cfs,
1476 int lo, int hi) {
1477 CompletableFuture<Void> d = new CompletableFuture<Void>();
1478 if (lo > hi) // empty
1479 d.result = NIL;
1480 else {
1481 CompletableFuture<?> a, b; Object r, s, z; Throwable x;
1482 int mid = (lo + hi) >>> 1;
1483 if ((a = (lo == mid ? cfs[lo] :
1484 andTree(cfs, lo, mid))) == null ||
1485 (b = (lo == hi ? a : (hi == mid+1) ? cfs[hi] :
1486 andTree(cfs, mid+1, hi))) == null)
1487 throw new NullPointerException();
1488 if ((r = a.result) == null || (s = b.result) == null)
1489 a.bipush(b, new BiRelay<>(d, a, b));
1490 else if ((r instanceof AltResult
1491 && (x = ((AltResult)(z = r)).ex) != null) ||
1492 (s instanceof AltResult
1493 && (x = ((AltResult)(z = s)).ex) != null))
1494 d.result = encodeThrowable(x, z);
1495 else
1496 d.result = NIL;
1497 }
1498 return d;
1499 }
1500
1501 /* ------------- Projected (Ored) BiCompletions -------------- */
1502
1503 /**
1504 * Pushes completion to this and b unless either done.
1505 * Caller should first check that result and b.result are both null.
1506 */
1507 final void orpush(CompletableFuture<?> b, BiCompletion<?,?,?> c) {
1508 if (c != null) {
1509 while (!tryPushStack(c)) {
1510 if (result != null) {
1511 NEXT.set(c, null);
1512 break;
1513 }
1514 }
1515 if (result != null)
1516 c.tryFire(SYNC);
1517 else
1518 b.unipush(new CoCompletion(c));
1519 }
1520 }
1521
1522 @SuppressWarnings("serial")
1523 static final class OrApply<T,U extends T,V> extends BiCompletion<T,U,V> {
1524 Function<? super T,? extends V> fn;
1525 OrApply(Executor executor, CompletableFuture<V> dep,
1526 CompletableFuture<T> src, CompletableFuture<U> snd,
1527 Function<? super T,? extends V> fn) {
1528 super(executor, dep, src, snd); this.fn = fn;
1529 }
1530 final CompletableFuture<V> tryFire(int mode) {
1531 CompletableFuture<V> d;
1532 CompletableFuture<T> a;
1533 CompletableFuture<U> b;
1534 Object r; Throwable x; Function<? super T,? extends V> f;
1535 if ((d = dep) == null || (f = fn) == null
1536 || (a = src) == null || (b = snd) == null
1537 || ((r = a.result) == null && (r = b.result) == null))
1538 return null;
1539 tryComplete: if (d.result == null) {
1540 try {
1541 if (mode <= 0 && !claim())
1542 return null;
1543 if (r instanceof AltResult) {
1544 if ((x = ((AltResult)r).ex) != null) {
1545 d.completeThrowable(x, r);
1546 break tryComplete;
1547 }
1548 r = null;
1549 }
1550 @SuppressWarnings("unchecked") T t = (T) r;
1551 d.completeValue(f.apply(t));
1552 } catch (Throwable ex) {
1553 d.completeThrowable(ex);
1554 }
1555 }
1556 dep = null; src = null; snd = null; fn = null;
1557 return d.postFire(a, b, mode);
1558 }
1559 }
1560
1561 private <U extends T,V> CompletableFuture<V> orApplyStage(
1562 Executor e, CompletionStage<U> o, Function<? super T, ? extends V> f) {
1563 CompletableFuture<U> b;
1564 if (f == null || (b = o.toCompletableFuture()) == null)
1565 throw new NullPointerException();
1566
1567 Object r; CompletableFuture<? extends T> z;
1568 if ((r = (z = this).result) != null ||
1569 (r = (z = b).result) != null)
1570 return z.uniApplyNow(r, e, f);
1571
1572 CompletableFuture<V> d = newIncompleteFuture();
1573 orpush(b, new OrApply<T,U,V>(e, d, this, b, f));
1574 return d;
1575 }
1576
1577 @SuppressWarnings("serial")
1578 static final class OrAccept<T,U extends T> extends BiCompletion<T,U,Void> {
1579 Consumer<? super T> fn;
1580 OrAccept(Executor executor, CompletableFuture<Void> dep,
1581 CompletableFuture<T> src, CompletableFuture<U> snd,
1582 Consumer<? super T> fn) {
1583 super(executor, dep, src, snd); this.fn = fn;
1584 }
1585 final CompletableFuture<Void> tryFire(int mode) {
1586 CompletableFuture<Void> d;
1587 CompletableFuture<T> a;
1588 CompletableFuture<U> b;
1589 Object r; Throwable x; Consumer<? super T> f;
1590 if ((d = dep) == null || (f = fn) == null
1591 || (a = src) == null || (b = snd) == null
1592 || ((r = a.result) == null && (r = b.result) == null))
1593 return null;
1594 tryComplete: if (d.result == null) {
1595 try {
1596 if (mode <= 0 && !claim())
1597 return null;
1598 if (r instanceof AltResult) {
1599 if ((x = ((AltResult)r).ex) != null) {
1600 d.completeThrowable(x, r);
1601 break tryComplete;
1602 }
1603 r = null;
1604 }
1605 @SuppressWarnings("unchecked") T t = (T) r;
1606 f.accept(t);
1607 d.completeNull();
1608 } catch (Throwable ex) {
1609 d.completeThrowable(ex);
1610 }
1611 }
1612 dep = null; src = null; snd = null; fn = null;
1613 return d.postFire(a, b, mode);
1614 }
1615 }
1616
1617 private <U extends T> CompletableFuture<Void> orAcceptStage(
1618 Executor e, CompletionStage<U> o, Consumer<? super T> f) {
1619 CompletableFuture<U> b;
1620 if (f == null || (b = o.toCompletableFuture()) == null)
1621 throw new NullPointerException();
1622
1623 Object r; CompletableFuture<? extends T> z;
1624 if ((r = (z = this).result) != null ||
1625 (r = (z = b).result) != null)
1626 return z.uniAcceptNow(r, e, f);
1627
1628 CompletableFuture<Void> d = newIncompleteFuture();
1629 orpush(b, new OrAccept<T,U>(e, d, this, b, f));
1630 return d;
1631 }
1632
1633 @SuppressWarnings("serial")
1634 static final class OrRun<T,U> extends BiCompletion<T,U,Void> {
1635 Runnable fn;
1636 OrRun(Executor executor, CompletableFuture<Void> dep,
1637 CompletableFuture<T> src, CompletableFuture<U> snd,
1638 Runnable fn) {
1639 super(executor, dep, src, snd); this.fn = fn;
1640 }
1641 final CompletableFuture<Void> tryFire(int mode) {
1642 CompletableFuture<Void> d;
1643 CompletableFuture<T> a;
1644 CompletableFuture<U> b;
1645 Object r; Throwable x; Runnable f;
1646 if ((d = dep) == null || (f = fn) == null
1647 || (a = src) == null || (b = snd) == null
1648 || ((r = a.result) == null && (r = b.result) == null))
1649 return null;
1650 if (d.result == null) {
1651 try {
1652 if (mode <= 0 && !claim())
1653 return null;
1654 else if (r instanceof AltResult
1655 && (x = ((AltResult)r).ex) != null)
1656 d.completeThrowable(x, r);
1657 else {
1658 f.run();
1659 d.completeNull();
1660 }
1661 } catch (Throwable ex) {
1662 d.completeThrowable(ex);
1663 }
1664 }
1665 dep = null; src = null; snd = null; fn = null;
1666 return d.postFire(a, b, mode);
1667 }
1668 }
1669
1670 private CompletableFuture<Void> orRunStage(Executor e, CompletionStage<?> o,
1671 Runnable f) {
1672 CompletableFuture<?> b;
1673 if (f == null || (b = o.toCompletableFuture()) == null)
1674 throw new NullPointerException();
1675
1676 Object r; CompletableFuture<?> z;
1677 if ((r = (z = this).result) != null ||
1678 (r = (z = b).result) != null)
1679 return z.uniRunNow(r, e, f);
1680
1681 CompletableFuture<Void> d = newIncompleteFuture();
1682 orpush(b, new OrRun<>(e, d, this, b, f));
1683 return d;
1684 }
1685
1686 /** Completion for an anyOf input future. */
1687 @SuppressWarnings("serial")
1688 static class AnyOf extends Completion {
1689 CompletableFuture<Object> dep; CompletableFuture<?> src;
1690 CompletableFuture<?>[] srcs;
1691 AnyOf(CompletableFuture<Object> dep, CompletableFuture<?> src,
1692 CompletableFuture<?>[] srcs) {
1693 this.dep = dep; this.src = src; this.srcs = srcs;
1694 }
1695 final CompletableFuture<Object> tryFire(int mode) {
1696 // assert mode != ASYNC;
1697 CompletableFuture<Object> d; CompletableFuture<?> a;
1698 CompletableFuture<?>[] as;
1699 Object r;
1700 if ((d = dep) == null
1701 || (a = src) == null || (r = a.result) == null
1702 || (as = srcs) == null)
1703 return null;
1704 dep = null; src = null; srcs = null;
1705 if (d.completeRelay(r)) {
1706 for (CompletableFuture<?> b : as)
1707 if (b != a)
1708 b.cleanStack();
1709 if (mode < 0)
1710 return d;
1711 else
1712 d.postComplete();
1713 }
1714 return null;
1715 }
1716 final boolean isLive() {
1717 CompletableFuture<Object> d;
1718 return (d = dep) != null && d.result == null;
1719 }
1720 }
1721
1722 /* ------------- Zero-input Async forms -------------- */
1723
1724 @SuppressWarnings("serial")
1725 static final class AsyncSupply<T> extends ForkJoinTask<Void>
1726 implements Runnable, AsynchronousCompletionTask {
1727 CompletableFuture<T> dep; Supplier<? extends T> fn;
1728 AsyncSupply(CompletableFuture<T> dep, Supplier<? extends T> fn) {
1729 this.dep = dep; this.fn = fn;
1730 }
1731
1732 public final Void getRawResult() { return null; }
1733 public final void setRawResult(Void v) {}
1734 public final boolean exec() { run(); return false; }
1735
1736 public void run() {
1737 CompletableFuture<T> d; Supplier<? extends T> f;
1738 if ((d = dep) != null && (f = fn) != null) {
1739 dep = null; fn = null;
1740 if (d.result == null) {
1741 try {
1742 d.completeValue(f.get());
1743 } catch (Throwable ex) {
1744 d.completeThrowable(ex);
1745 }
1746 }
1747 d.postComplete();
1748 }
1749 }
1750 }
1751
1752 static <U> CompletableFuture<U> asyncSupplyStage(Executor e,
1753 Supplier<U> f) {
1754 if (f == null) throw new NullPointerException();
1755 CompletableFuture<U> d = new CompletableFuture<U>();
1756 e.execute(new AsyncSupply<U>(d, f));
1757 return d;
1758 }
1759
1760 @SuppressWarnings("serial")
1761 static final class AsyncRun extends ForkJoinTask<Void>
1762 implements Runnable, AsynchronousCompletionTask {
1763 CompletableFuture<Void> dep; Runnable fn;
1764 AsyncRun(CompletableFuture<Void> dep, Runnable fn) {
1765 this.dep = dep; this.fn = fn;
1766 }
1767
1768 public final Void getRawResult() { return null; }
1769 public final void setRawResult(Void v) {}
1770 public final boolean exec() { run(); return false; }
1771
1772 public void run() {
1773 CompletableFuture<Void> d; Runnable f;
1774 if ((d = dep) != null && (f = fn) != null) {
1775 dep = null; fn = null;
1776 if (d.result == null) {
1777 try {
1778 f.run();
1779 d.completeNull();
1780 } catch (Throwable ex) {
1781 d.completeThrowable(ex);
1782 }
1783 }
1784 d.postComplete();
1785 }
1786 }
1787 }
1788
1789 static CompletableFuture<Void> asyncRunStage(Executor e, Runnable f) {
1790 if (f == null) throw new NullPointerException();
1791 CompletableFuture<Void> d = new CompletableFuture<Void>();
1792 e.execute(new AsyncRun(d, f));
1793 return d;
1794 }
1795
1796 /* ------------- Signallers -------------- */
1797
1798 /**
1799 * Completion for recording and releasing a waiting thread. This
1800 * class implements ManagedBlocker to avoid starvation when
1801 * blocking actions pile up in ForkJoinPools.
1802 */
1803 @SuppressWarnings("serial")
1804 static final class Signaller extends Completion
1805 implements ForkJoinPool.ManagedBlocker {
1806 long nanos; // remaining wait time if timed
1807 final long deadline; // non-zero if timed
1808 final boolean interruptible;
1809 boolean interrupted;
1810 volatile Thread thread;
1811
1812 Signaller(boolean interruptible, long nanos, long deadline) {
1813 this.thread = Thread.currentThread();
1814 this.interruptible = interruptible;
1815 this.nanos = nanos;
1816 this.deadline = deadline;
1817 }
1818 final CompletableFuture<?> tryFire(int ignore) {
1819 Thread w; // no need to atomically claim
1820 if ((w = thread) != null) {
1821 thread = null;
1822 LockSupport.unpark(w);
1823 }
1824 return null;
1825 }
1826 public boolean isReleasable() {
1827 if (Thread.interrupted())
1828 interrupted = true;
1829 return ((interrupted && interruptible) ||
1830 (deadline != 0L &&
1831 (nanos <= 0L ||
1832 (nanos = deadline - System.nanoTime()) <= 0L)) ||
1833 thread == null);
1834 }
1835 public boolean block() {
1836 while (!isReleasable()) {
1837 if (deadline == 0L)
1838 LockSupport.park(this);
1839 else
1840 LockSupport.parkNanos(this, nanos);
1841 }
1842 return true;
1843 }
1844 final boolean isLive() { return thread != null; }
1845 }
1846
1847 /**
1848 * Returns raw result after waiting, or null if interruptible and
1849 * interrupted.
1850 */
1851 private Object waitingGet(boolean interruptible) {
1852 Signaller q = null;
1853 boolean queued = false;
1854 Object r;
1855 while ((r = result) == null) {
1856 if (q == null) {
1857 q = new Signaller(interruptible, 0L, 0L);
1858 if (Thread.currentThread() instanceof ForkJoinWorkerThread)
1859 ForkJoinPool.helpAsyncBlocker(defaultExecutor(), q);
1860 }
1861 else if (!queued)
1862 queued = tryPushStack(q);
1863 else {
1864 try {
1865 ForkJoinPool.managedBlock(q);
1866 } catch (InterruptedException ie) { // currently cannot happen
1867 q.interrupted = true;
1868 }
1869 if (q.interrupted && interruptible)
1870 break;
1871 }
1872 }
1873 if (q != null && queued) {
1874 q.thread = null;
1875 if (!interruptible && q.interrupted)
1876 Thread.currentThread().interrupt();
1877 if (r == null)
1878 cleanStack();
1879 }
1880 if (r != null || (r = result) != null)
1881 postComplete();
1882 return r;
1883 }
1884
1885 /**
1886 * Returns raw result after waiting, or null if interrupted, or
1887 * throws TimeoutException on timeout.
1888 */
1889 private Object timedGet(long nanos) throws TimeoutException {
1890 if (Thread.interrupted())
1891 return null;
1892 if (nanos > 0L) {
1893 long d = System.nanoTime() + nanos;
1894 long deadline = (d == 0L) ? 1L : d; // avoid 0
1895 Signaller q = null;
1896 boolean queued = false;
1897 Object r;
1898 while ((r = result) == null) { // similar to untimed
1899 if (q == null) {
1900 q = new Signaller(true, nanos, deadline);
1901 if (Thread.currentThread() instanceof ForkJoinWorkerThread)
1902 ForkJoinPool.helpAsyncBlocker(defaultExecutor(), q);
1903 }
1904 else if (!queued)
1905 queued = tryPushStack(q);
1906 else if (q.nanos <= 0L)
1907 break;
1908 else {
1909 try {
1910 ForkJoinPool.managedBlock(q);
1911 } catch (InterruptedException ie) {
1912 q.interrupted = true;
1913 }
1914 if (q.interrupted)
1915 break;
1916 }
1917 }
1918 if (q != null && queued) {
1919 q.thread = null;
1920 if (r == null)
1921 cleanStack();
1922 }
1923 if (r != null || (r = result) != null)
1924 postComplete();
1925 if (r != null || (q != null && q.interrupted))
1926 return r;
1927 }
1928 throw new TimeoutException();
1929 }
1930
1931 /* ------------- public methods -------------- */
1932
1933 /**
1934 * Creates a new incomplete CompletableFuture.
1935 */
1936 public CompletableFuture() {
1937 }
1938
1939 /**
1940 * Creates a new complete CompletableFuture with given encoded result.
1941 */
1942 CompletableFuture(Object r) {
1943 this.result = r;
1944 }
1945
1946 /**
1947 * Returns a new CompletableFuture that is asynchronously completed
1948 * by a task running in the {@link ForkJoinPool#commonPool()} with
1949 * the value obtained by calling the given Supplier.
1950 *
1951 * @param supplier a function returning the value to be used
1952 * to complete the returned CompletableFuture
1953 * @param <U> the function's return type
1954 * @return the new CompletableFuture
1955 */
1956 public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier) {
1957 return asyncSupplyStage(ASYNC_POOL, supplier);
1958 }
1959
1960 /**
1961 * Returns a new CompletableFuture that is asynchronously completed
1962 * by a task running in the given executor with the value obtained
1963 * by calling the given Supplier.
1964 *
1965 * @param supplier a function returning the value to be used
1966 * to complete the returned CompletableFuture
1967 * @param executor the executor to use for asynchronous execution
1968 * @param <U> the function's return type
1969 * @return the new CompletableFuture
1970 */
1971 public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier,
1972 Executor executor) {
1973 return asyncSupplyStage(screenExecutor(executor), supplier);
1974 }
1975
1976 /**
1977 * Returns a new CompletableFuture that is asynchronously completed
1978 * by a task running in the {@link ForkJoinPool#commonPool()} after
1979 * it runs the given action.
1980 *
1981 * @param runnable the action to run before completing the
1982 * returned CompletableFuture
1983 * @return the new CompletableFuture
1984 */
1985 public static CompletableFuture<Void> runAsync(Runnable runnable) {
1986 return asyncRunStage(ASYNC_POOL, runnable);
1987 }
1988
1989 /**
1990 * Returns a new CompletableFuture that is asynchronously completed
1991 * by a task running in the given executor after it runs the given
1992 * action.
1993 *
1994 * @param runnable the action to run before completing the
1995 * returned CompletableFuture
1996 * @param executor the executor to use for asynchronous execution
1997 * @return the new CompletableFuture
1998 */
1999 public static CompletableFuture<Void> runAsync(Runnable runnable,
2000 Executor executor) {
2001 return asyncRunStage(screenExecutor(executor), runnable);
2002 }
2003
2004 /**
2005 * Returns a new CompletableFuture that is already completed with
2006 * the given value.
2007 *
2008 * @param value the value
2009 * @param <U> the type of the value
2010 * @return the completed CompletableFuture
2011 */
2012 public static <U> CompletableFuture<U> completedFuture(U value) {
2013 return new CompletableFuture<U>((value == null) ? NIL : value);
2014 }
2015
2016 /**
2017 * Returns {@code true} if completed in any fashion: normally,
2018 * exceptionally, or via cancellation.
2019 *
2020 * @return {@code true} if completed
2021 */
2022 public boolean isDone() {
2023 return result != null;
2024 }
2025
2026 /**
2027 * Waits if necessary for this future to complete, and then
2028 * returns its result.
2029 *
2030 * @return the result value
2031 * @throws CancellationException if this future was cancelled
2032 * @throws ExecutionException if this future completed exceptionally
2033 * @throws InterruptedException if the current thread was interrupted
2034 * while waiting
2035 */
2036 @SuppressWarnings("unchecked")
2037 public T get() throws InterruptedException, ExecutionException {
2038 Object r;
2039 if ((r = result) == null)
2040 r = waitingGet(true);
2041 return (T) reportGet(r);
2042 }
2043
2044 /**
2045 * Waits if necessary for at most the given time for this future
2046 * to complete, and then returns its result, if available.
2047 *
2048 * @param timeout the maximum time to wait
2049 * @param unit the time unit of the timeout argument
2050 * @return the result value
2051 * @throws CancellationException if this future was cancelled
2052 * @throws ExecutionException if this future completed exceptionally
2053 * @throws InterruptedException if the current thread was interrupted
2054 * while waiting
2055 * @throws TimeoutException if the wait timed out
2056 */
2057 @SuppressWarnings("unchecked")
2058 public T get(long timeout, TimeUnit unit)
2059 throws InterruptedException, ExecutionException, TimeoutException {
2060 long nanos = unit.toNanos(timeout);
2061 Object r;
2062 if ((r = result) == null)
2063 r = timedGet(nanos);
2064 return (T) reportGet(r);
2065 }
2066
2067 /**
2068 * Returns the result value when complete, or throws an
2069 * (unchecked) exception if completed exceptionally. To better
2070 * conform with the use of common functional forms, if a
2071 * computation involved in the completion of this
2072 * CompletableFuture threw an exception, this method throws an
2073 * (unchecked) {@link CompletionException} with the underlying
2074 * exception as its cause.
2075 *
2076 * @return the result value
2077 * @throws CancellationException if the computation was cancelled
2078 * @throws CompletionException if this future completed
2079 * exceptionally or a completion computation threw an exception
2080 */
2081 @SuppressWarnings("unchecked")
2082 public T join() {
2083 Object r;
2084 if ((r = result) == null)
2085 r = waitingGet(false);
2086 return (T) reportJoin(r);
2087 }
2088
2089 /**
2090 * Returns the result value (or throws any encountered exception)
2091 * if completed, else returns the given valueIfAbsent.
2092 *
2093 * @param valueIfAbsent the value to return if not completed
2094 * @return the result value, if completed, else the given valueIfAbsent
2095 * @throws CancellationException if the computation was cancelled
2096 * @throws CompletionException if this future completed
2097 * exceptionally or a completion computation threw an exception
2098 */
2099 @SuppressWarnings("unchecked")
2100 public T getNow(T valueIfAbsent) {
2101 Object r;
2102 return ((r = result) == null) ? valueIfAbsent : (T) reportJoin(r);
2103 }
2104
2105 /**
2106 * If not already completed, sets the value returned by {@link
2107 * #get()} and related methods to the given value.
2108 *
2109 * @param value the result value
2110 * @return {@code true} if this invocation caused this CompletableFuture
2111 * to transition to a completed state, else {@code false}
2112 */
2113 public boolean complete(T value) {
2114 boolean triggered = completeValue(value);
2115 postComplete();
2116 return triggered;
2117 }
2118
2119 /**
2120 * If not already completed, causes invocations of {@link #get()}
2121 * and related methods to throw the given exception.
2122 *
2123 * @param ex the exception
2124 * @return {@code true} if this invocation caused this CompletableFuture
2125 * to transition to a completed state, else {@code false}
2126 */
2127 public boolean completeExceptionally(Throwable ex) {
2128 if (ex == null) throw new NullPointerException();
2129 boolean triggered = internalComplete(new AltResult(ex));
2130 postComplete();
2131 return triggered;
2132 }
2133
2134 public <U> CompletableFuture<U> thenApply(
2135 Function<? super T,? extends U> fn) {
2136 return uniApplyStage(null, fn);
2137 }
2138
2139 public <U> CompletableFuture<U> thenApplyAsync(
2140 Function<? super T,? extends U> fn) {
2141 return uniApplyStage(defaultExecutor(), fn);
2142 }
2143
2144 public <U> CompletableFuture<U> thenApplyAsync(
2145 Function<? super T,? extends U> fn, Executor executor) {
2146 return uniApplyStage(screenExecutor(executor), fn);
2147 }
2148
2149 public CompletableFuture<Void> thenAccept(Consumer<? super T> action) {
2150 return uniAcceptStage(null, action);
2151 }
2152
2153 public CompletableFuture<Void> thenAcceptAsync(Consumer<? super T> action) {
2154 return uniAcceptStage(defaultExecutor(), action);
2155 }
2156
2157 public CompletableFuture<Void> thenAcceptAsync(Consumer<? super T> action,
2158 Executor executor) {
2159 return uniAcceptStage(screenExecutor(executor), action);
2160 }
2161
2162 public CompletableFuture<Void> thenRun(Runnable action) {
2163 return uniRunStage(null, action);
2164 }
2165
2166 public CompletableFuture<Void> thenRunAsync(Runnable action) {
2167 return uniRunStage(defaultExecutor(), action);
2168 }
2169
2170 public CompletableFuture<Void> thenRunAsync(Runnable action,
2171 Executor executor) {
2172 return uniRunStage(screenExecutor(executor), action);
2173 }
2174
2175 public <U,V> CompletableFuture<V> thenCombine(
2176 CompletionStage<? extends U> other,
2177 BiFunction<? super T,? super U,? extends V> fn) {
2178 return biApplyStage(null, other, fn);
2179 }
2180
2181 public <U,V> CompletableFuture<V> thenCombineAsync(
2182 CompletionStage<? extends U> other,
2183 BiFunction<? super T,? super U,? extends V> fn) {
2184 return biApplyStage(defaultExecutor(), other, fn);
2185 }
2186
2187 public <U,V> CompletableFuture<V> thenCombineAsync(
2188 CompletionStage<? extends U> other,
2189 BiFunction<? super T,? super U,? extends V> fn, Executor executor) {
2190 return biApplyStage(screenExecutor(executor), other, fn);
2191 }
2192
2193 public <U> CompletableFuture<Void> thenAcceptBoth(
2194 CompletionStage<? extends U> other,
2195 BiConsumer<? super T, ? super U> action) {
2196 return biAcceptStage(null, other, action);
2197 }
2198
2199 public <U> CompletableFuture<Void> thenAcceptBothAsync(
2200 CompletionStage<? extends U> other,
2201 BiConsumer<? super T, ? super U> action) {
2202 return biAcceptStage(defaultExecutor(), other, action);
2203 }
2204
2205 public <U> CompletableFuture<Void> thenAcceptBothAsync(
2206 CompletionStage<? extends U> other,
2207 BiConsumer<? super T, ? super U> action, Executor executor) {
2208 return biAcceptStage(screenExecutor(executor), other, action);
2209 }
2210
2211 public CompletableFuture<Void> runAfterBoth(CompletionStage<?> other,
2212 Runnable action) {
2213 return biRunStage(null, other, action);
2214 }
2215
2216 public CompletableFuture<Void> runAfterBothAsync(CompletionStage<?> other,
2217 Runnable action) {
2218 return biRunStage(defaultExecutor(), other, action);
2219 }
2220
2221 public CompletableFuture<Void> runAfterBothAsync(CompletionStage<?> other,
2222 Runnable action,
2223 Executor executor) {
2224 return biRunStage(screenExecutor(executor), other, action);
2225 }
2226
2227 public <U> CompletableFuture<U> applyToEither(
2228 CompletionStage<? extends T> other, Function<? super T, U> fn) {
2229 return orApplyStage(null, other, fn);
2230 }
2231
2232 public <U> CompletableFuture<U> applyToEitherAsync(
2233 CompletionStage<? extends T> other, Function<? super T, U> fn) {
2234 return orApplyStage(defaultExecutor(), other, fn);
2235 }
2236
2237 public <U> CompletableFuture<U> applyToEitherAsync(
2238 CompletionStage<? extends T> other, Function<? super T, U> fn,
2239 Executor executor) {
2240 return orApplyStage(screenExecutor(executor), other, fn);
2241 }
2242
2243 public CompletableFuture<Void> acceptEither(
2244 CompletionStage<? extends T> other, Consumer<? super T> action) {
2245 return orAcceptStage(null, other, action);
2246 }
2247
2248 public CompletableFuture<Void> acceptEitherAsync(
2249 CompletionStage<? extends T> other, Consumer<? super T> action) {
2250 return orAcceptStage(defaultExecutor(), other, action);
2251 }
2252
2253 public CompletableFuture<Void> acceptEitherAsync(
2254 CompletionStage<? extends T> other, Consumer<? super T> action,
2255 Executor executor) {
2256 return orAcceptStage(screenExecutor(executor), other, action);
2257 }
2258
2259 public CompletableFuture<Void> runAfterEither(CompletionStage<?> other,
2260 Runnable action) {
2261 return orRunStage(null, other, action);
2262 }
2263
2264 public CompletableFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
2265 Runnable action) {
2266 return orRunStage(defaultExecutor(), other, action);
2267 }
2268
2269 public CompletableFuture<Void> runAfterEitherAsync(CompletionStage<?> other,
2270 Runnable action,
2271 Executor executor) {
2272 return orRunStage(screenExecutor(executor), other, action);
2273 }
2274
2275 public <U> CompletableFuture<U> thenCompose(
2276 Function<? super T, ? extends CompletionStage<U>> fn) {
2277 return uniComposeStage(null, fn);
2278 }
2279
2280 public <U> CompletableFuture<U> thenComposeAsync(
2281 Function<? super T, ? extends CompletionStage<U>> fn) {
2282 return uniComposeStage(defaultExecutor(), fn);
2283 }
2284
2285 public <U> CompletableFuture<U> thenComposeAsync(
2286 Function<? super T, ? extends CompletionStage<U>> fn,
2287 Executor executor) {
2288 return uniComposeStage(screenExecutor(executor), fn);
2289 }
2290
2291 public CompletableFuture<T> whenComplete(
2292 BiConsumer<? super T, ? super Throwable> action) {
2293 return uniWhenCompleteStage(null, action);
2294 }
2295
2296 public CompletableFuture<T> whenCompleteAsync(
2297 BiConsumer<? super T, ? super Throwable> action) {
2298 return uniWhenCompleteStage(defaultExecutor(), action);
2299 }
2300
2301 public CompletableFuture<T> whenCompleteAsync(
2302 BiConsumer<? super T, ? super Throwable> action, Executor executor) {
2303 return uniWhenCompleteStage(screenExecutor(executor), action);
2304 }
2305
2306 public <U> CompletableFuture<U> handle(
2307 BiFunction<? super T, Throwable, ? extends U> fn) {
2308 return uniHandleStage(null, fn);
2309 }
2310
2311 public <U> CompletableFuture<U> handleAsync(
2312 BiFunction<? super T, Throwable, ? extends U> fn) {
2313 return uniHandleStage(defaultExecutor(), fn);
2314 }
2315
2316 public <U> CompletableFuture<U> handleAsync(
2317 BiFunction<? super T, Throwable, ? extends U> fn, Executor executor) {
2318 return uniHandleStage(screenExecutor(executor), fn);
2319 }
2320
2321 /**
2322 * Returns this CompletableFuture.
2323 *
2324 * @return this CompletableFuture
2325 */
2326 public CompletableFuture<T> toCompletableFuture() {
2327 return this;
2328 }
2329
2330 public CompletableFuture<T> exceptionally(
2331 Function<Throwable, ? extends T> fn) {
2332 return uniExceptionallyStage(null, fn);
2333 }
2334
2335 public CompletableFuture<T> exceptionallyAsync(
2336 Function<Throwable, ? extends T> fn) {
2337 return uniExceptionallyStage(defaultExecutor(), fn);
2338 }
2339
2340 public CompletableFuture<T> exceptionallyAsync(
2341 Function<Throwable, ? extends T> fn, Executor executor) {
2342 return uniExceptionallyStage(screenExecutor(executor), fn);
2343 }
2344
2345 public CompletableFuture<T> exceptionallyCompose(
2346 Function<Throwable, ? extends CompletionStage<T>> fn) {
2347 return uniComposeExceptionallyStage(null, fn);
2348 }
2349
2350 public CompletableFuture<T> exceptionallyComposeAsync(
2351 Function<Throwable, ? extends CompletionStage<T>> fn) {
2352 return uniComposeExceptionallyStage(defaultExecutor(), fn);
2353 }
2354
2355 public CompletableFuture<T> exceptionallyComposeAsync(
2356 Function<Throwable, ? extends CompletionStage<T>> fn,
2357 Executor executor) {
2358 return uniComposeExceptionallyStage(screenExecutor(executor), fn);
2359 }
2360
2361 /* ------------- Arbitrary-arity constructions -------------- */
2362
2363 /**
2364 * Returns a new CompletableFuture that is completed when all of
2365 * the given CompletableFutures complete. If any of the given
2366 * CompletableFutures complete exceptionally, then the returned
2367 * CompletableFuture also does so, with a CompletionException
2368 * holding this exception as its cause. Otherwise, the results,
2369 * if any, of the given CompletableFutures are not reflected in
2370 * the returned CompletableFuture, but may be obtained by
2371 * inspecting them individually. If no CompletableFutures are
2372 * provided, returns a CompletableFuture completed with the value
2373 * {@code null}.
2374 *
2375 * <p>Among the applications of this method is to await completion
2376 * of a set of independent CompletableFutures before continuing a
2377 * program, as in: {@code CompletableFuture.allOf(c1, c2,
2378 * c3).join();}.
2379 *
2380 * @param cfs the CompletableFutures
2381 * @return a new CompletableFuture that is completed when all of the
2382 * given CompletableFutures complete
2383 * @throws NullPointerException if the array or any of its elements are
2384 * {@code null}
2385 */
2386 public static CompletableFuture<Void> allOf(CompletableFuture<?>... cfs) {
2387 return andTree(cfs, 0, cfs.length - 1);
2388 }
2389
2390 /**
2391 * Returns a new CompletableFuture that is completed when any of
2392 * the given CompletableFutures complete, with the same result.
2393 * Otherwise, if it completed exceptionally, the returned
2394 * CompletableFuture also does so, with a CompletionException
2395 * holding this exception as its cause. If no CompletableFutures
2396 * are provided, returns an incomplete CompletableFuture.
2397 *
2398 * @param cfs the CompletableFutures
2399 * @return a new CompletableFuture that is completed with the
2400 * result or exception of any of the given CompletableFutures when
2401 * one completes
2402 * @throws NullPointerException if the array or any of its elements are
2403 * {@code null}
2404 */
2405 public static CompletableFuture<Object> anyOf(CompletableFuture<?>... cfs) {
2406 int n; Object r;
2407 if ((n = cfs.length) <= 1)
2408 return (n == 0)
2409 ? new CompletableFuture<Object>()
2410 : uniCopyStage(cfs[0]);
2411 for (CompletableFuture<?> cf : cfs)
2412 if ((r = cf.result) != null)
2413 return new CompletableFuture<Object>(encodeRelay(r));
2414 cfs = cfs.clone();
2415 CompletableFuture<Object> d = new CompletableFuture<>();
2416 for (CompletableFuture<?> cf : cfs)
2417 cf.unipush(new AnyOf(d, cf, cfs));
2418 // If d was completed while we were adding completions, we should
2419 // clean the stack of any sources that may have had completions
2420 // pushed on their stack after d was completed.
2421 if (d.result != null)
2422 for (int i = 0, len = cfs.length; i < len; i++)
2423 if (cfs[i].result != null)
2424 for (i++; i < len; i++)
2425 if (cfs[i].result == null)
2426 cfs[i].cleanStack();
2427 return d;
2428 }
2429
2430 /* ------------- Control and status methods -------------- */
2431
2432 /**
2433 * If not already completed, completes this CompletableFuture with
2434 * a {@link CancellationException}. Dependent CompletableFutures
2435 * that have not already completed will also complete
2436 * exceptionally, with a {@link CompletionException} caused by
2437 * this {@code CancellationException}.
2438 *
2439 * @param mayInterruptIfRunning this value has no effect in this
2440 * implementation because interrupts are not used to control
2441 * processing.
2442 *
2443 * @return {@code true} if this task is now cancelled
2444 */
2445 public boolean cancel(boolean mayInterruptIfRunning) {
2446 boolean cancelled = (result == null) &&
2447 internalComplete(new AltResult(new CancellationException()));
2448 postComplete();
2449 return cancelled || isCancelled();
2450 }
2451
2452 /**
2453 * Returns {@code true} if this CompletableFuture was cancelled
2454 * before it completed normally.
2455 *
2456 * @return {@code true} if this CompletableFuture was cancelled
2457 * before it completed normally
2458 */
2459 public boolean isCancelled() {
2460 Object r;
2461 return ((r = result) instanceof AltResult) &&
2462 (((AltResult)r).ex instanceof CancellationException);
2463 }
2464
2465 /**
2466 * Returns {@code true} if this CompletableFuture completed
2467 * exceptionally, in any way. Possible causes include
2468 * cancellation, explicit invocation of {@code
2469 * completeExceptionally}, and abrupt termination of a
2470 * CompletionStage action.
2471 *
2472 * @return {@code true} if this CompletableFuture completed
2473 * exceptionally
2474 */
2475 public boolean isCompletedExceptionally() {
2476 Object r;
2477 return ((r = result) instanceof AltResult) && r != NIL;
2478 }
2479
2480 /**
2481 * Forcibly sets or resets the value subsequently returned by
2482 * method {@link #get()} and related methods, whether or not
2483 * already completed. This method is designed for use only in
2484 * error recovery actions, and even in such situations may result
2485 * in ongoing dependent completions using established versus
2486 * overwritten outcomes.
2487 *
2488 * @param value the completion value
2489 */
2490 public void obtrudeValue(T value) {
2491 result = (value == null) ? NIL : value;
2492 postComplete();
2493 }
2494
2495 /**
2496 * Forcibly causes subsequent invocations of method {@link #get()}
2497 * and related methods to throw the given exception, whether or
2498 * not already completed. This method is designed for use only in
2499 * error recovery actions, and even in such situations may result
2500 * in ongoing dependent completions using established versus
2501 * overwritten outcomes.
2502 *
2503 * @param ex the exception
2504 * @throws NullPointerException if the exception is null
2505 */
2506 public void obtrudeException(Throwable ex) {
2507 if (ex == null) throw new NullPointerException();
2508 result = new AltResult(ex);
2509 postComplete();
2510 }
2511
2512 /**
2513 * Returns the estimated number of CompletableFutures whose
2514 * completions are awaiting completion of this CompletableFuture.
2515 * This method is designed for use in monitoring system state, not
2516 * for synchronization control.
2517 *
2518 * @return the number of dependent CompletableFutures
2519 */
2520 public int getNumberOfDependents() {
2521 int count = 0;
2522 for (Completion p = stack; p != null; p = p.next)
2523 ++count;
2524 return count;
2525 }
2526
2527 /**
2528 * Returns a string identifying this CompletableFuture, as well as
2529 * its completion state. The state, in brackets, contains the
2530 * String {@code "Completed Normally"} or the String {@code
2531 * "Completed Exceptionally"}, or the String {@code "Not
2532 * completed"} followed by the number of CompletableFutures
2533 * dependent upon its completion, if any.
2534 *
2535 * @return a string identifying this CompletableFuture, as well as its state
2536 */
2537 public String toString() {
2538 Object r = result;
2539 int count = 0; // avoid call to getNumberOfDependents in case disabled
2540 for (Completion p = stack; p != null; p = p.next)
2541 ++count;
2542 return super.toString() +
2543 ((r == null)
2544 ? ((count == 0)
2545 ? "[Not completed]"
2546 : "[Not completed, " + count + " dependents]")
2547 : (((r instanceof AltResult) && ((AltResult)r).ex != null)
2548 ? "[Completed exceptionally: " + ((AltResult)r).ex + "]"
2549 : "[Completed normally]"));
2550 }
2551
2552 // jdk9 additions
2553
2554 /**
2555 * Returns a new incomplete CompletableFuture of the type to be
2556 * returned by a CompletionStage method. Subclasses should
2557 * normally override this method to return an instance of the same
2558 * class as this CompletableFuture. The default implementation
2559 * returns an instance of class CompletableFuture.
2560 *
2561 * @param <U> the type of the value
2562 * @return a new CompletableFuture
2563 * @since 9
2564 */
2565 public <U> CompletableFuture<U> newIncompleteFuture() {
2566 return new CompletableFuture<U>();
2567 }
2568
2569 /**
2570 * Returns the default Executor used for async methods that do not
2571 * specify an Executor. This class uses the {@link
2572 * ForkJoinPool#commonPool()} if it supports more than one
2573 * parallel thread, or else an Executor using one thread per async
2574 * task. This method may be overridden in subclasses to return
2575 * an Executor that provides at least one independent thread.
2576 *
2577 * @return the executor
2578 * @since 9
2579 */
2580 public Executor defaultExecutor() {
2581 return ASYNC_POOL;
2582 }
2583
2584 /**
2585 * Returns a new CompletableFuture that is completed normally with
2586 * the same value as this CompletableFuture when it completes
2587 * normally. If this CompletableFuture completes exceptionally,
2588 * then the returned CompletableFuture completes exceptionally
2589 * with a CompletionException with this exception as cause. The
2590 * behavior is equivalent to {@code thenApply(x -> x)}. This
2591 * method may be useful as a form of "defensive copying", to
2592 * prevent clients from completing, while still being able to
2593 * arrange dependent actions.
2594 *
2595 * @return the new CompletableFuture
2596 * @since 9
2597 */
2598 public CompletableFuture<T> copy() {
2599 return uniCopyStage(this);
2600 }
2601
2602 /**
2603 * Returns a new CompletionStage that is completed normally with
2604 * the same value as this CompletableFuture when it completes
2605 * normally, and cannot be independently completed or otherwise
2606 * used in ways not defined by the methods of interface {@link
2607 * CompletionStage}. If this CompletableFuture completes
2608 * exceptionally, then the returned CompletionStage completes
2609 * exceptionally with a CompletionException with this exception as
2610 * cause.
2611 *
2612 * <p>Unless overridden by a subclass, a new non-minimal
2613 * CompletableFuture with all methods available can be obtained from
2614 * a minimal CompletionStage via {@link #toCompletableFuture()}.
2615 * For example, completion of a minimal stage can be awaited by
2616 *
2617 * <pre> {@code minimalStage.toCompletableFuture().join(); }</pre>
2618 *
2619 * @return the new CompletionStage
2620 * @since 9
2621 */
2622 public CompletionStage<T> minimalCompletionStage() {
2623 return uniAsMinimalStage();
2624 }
2625
2626 /**
2627 * Completes this CompletableFuture with the result of
2628 * the given Supplier function invoked from an asynchronous
2629 * task using the given executor.
2630 *
2631 * @param supplier a function returning the value to be used
2632 * to complete this CompletableFuture
2633 * @param executor the executor to use for asynchronous execution
2634 * @return this CompletableFuture
2635 * @since 9
2636 */
2637 public CompletableFuture<T> completeAsync(Supplier<? extends T> supplier,
2638 Executor executor) {
2639 if (supplier == null || executor == null)
2640 throw new NullPointerException();
2641 executor.execute(new AsyncSupply<T>(this, supplier));
2642 return this;
2643 }
2644
2645 /**
2646 * Completes this CompletableFuture with the result of the given
2647 * Supplier function invoked from an asynchronous task using the
2648 * default executor.
2649 *
2650 * @param supplier a function returning the value to be used
2651 * to complete this CompletableFuture
2652 * @return this CompletableFuture
2653 * @since 9
2654 */
2655 public CompletableFuture<T> completeAsync(Supplier<? extends T> supplier) {
2656 return completeAsync(supplier, defaultExecutor());
2657 }
2658
2659 /**
2660 * Exceptionally completes this CompletableFuture with
2661 * a {@link TimeoutException} if not otherwise completed
2662 * before the given timeout.
2663 *
2664 * @param timeout how long to wait before completing exceptionally
2665 * with a TimeoutException, in units of {@code unit}
2666 * @param unit a {@code TimeUnit} determining how to interpret the
2667 * {@code timeout} parameter
2668 * @return this CompletableFuture
2669 * @since 9
2670 */
2671 public CompletableFuture<T> orTimeout(long timeout, TimeUnit unit) {
2672 if (unit == null)
2673 throw new NullPointerException();
2674 if (result == null)
2675 whenComplete(new Canceller(Delayer.delay(new Timeout(this),
2676 timeout, unit)));
2677 return this;
2678 }
2679
2680 /**
2681 * Completes this CompletableFuture with the given value if not
2682 * otherwise completed before the given timeout.
2683 *
2684 * @param value the value to use upon timeout
2685 * @param timeout how long to wait before completing normally
2686 * with the given value, in units of {@code unit}
2687 * @param unit a {@code TimeUnit} determining how to interpret the
2688 * {@code timeout} parameter
2689 * @return this CompletableFuture
2690 * @since 9
2691 */
2692 public CompletableFuture<T> completeOnTimeout(T value, long timeout,
2693 TimeUnit unit) {
2694 if (unit == null)
2695 throw new NullPointerException();
2696 if (result == null)
2697 whenComplete(new Canceller(Delayer.delay(
2698 new DelayedCompleter<T>(this, value),
2699 timeout, unit)));
2700 return this;
2701 }
2702
2703 /**
2704 * Returns a new Executor that submits a task to the given base
2705 * executor after the given delay (or no delay if non-positive).
2706 * Each delay commences upon invocation of the returned executor's
2707 * {@code execute} method.
2708 *
2709 * @param delay how long to delay, in units of {@code unit}
2710 * @param unit a {@code TimeUnit} determining how to interpret the
2711 * {@code delay} parameter
2712 * @param executor the base executor
2713 * @return the new delayed executor
2714 * @since 9
2715 */
2716 public static Executor delayedExecutor(long delay, TimeUnit unit,
2717 Executor executor) {
2718 if (unit == null || executor == null)
2719 throw new NullPointerException();
2720 return new DelayedExecutor(delay, unit, executor);
2721 }
2722
2723 /**
2724 * Returns a new Executor that submits a task to the default
2725 * executor after the given delay (or no delay if non-positive).
2726 * Each delay commences upon invocation of the returned executor's
2727 * {@code execute} method.
2728 *
2729 * @param delay how long to delay, in units of {@code unit}
2730 * @param unit a {@code TimeUnit} determining how to interpret the
2731 * {@code delay} parameter
2732 * @return the new delayed executor
2733 * @since 9
2734 */
2735 public static Executor delayedExecutor(long delay, TimeUnit unit) {
2736 if (unit == null)
2737 throw new NullPointerException();
2738 return new DelayedExecutor(delay, unit, ASYNC_POOL);
2739 }
2740
2741 /**
2742 * Returns a new CompletionStage that is already completed with
2743 * the given value and supports only those methods in
2744 * interface {@link CompletionStage}.
2745 *
2746 * @param value the value
2747 * @param <U> the type of the value
2748 * @return the completed CompletionStage
2749 * @since 9
2750 */
2751 public static <U> CompletionStage<U> completedStage(U value) {
2752 return new MinimalStage<U>((value == null) ? NIL : value);
2753 }
2754
2755 /**
2756 * Returns a new CompletableFuture that is already completed
2757 * exceptionally with the given exception.
2758 *
2759 * @param ex the exception
2760 * @param <U> the type of the value
2761 * @return the exceptionally completed CompletableFuture
2762 * @since 9
2763 */
2764 public static <U> CompletableFuture<U> failedFuture(Throwable ex) {
2765 if (ex == null) throw new NullPointerException();
2766 return new CompletableFuture<U>(new AltResult(ex));
2767 }
2768
2769 /**
2770 * Returns a new CompletionStage that is already completed
2771 * exceptionally with the given exception and supports only those
2772 * methods in interface {@link CompletionStage}.
2773 *
2774 * @param ex the exception
2775 * @param <U> the type of the value
2776 * @return the exceptionally completed CompletionStage
2777 * @since 9
2778 */
2779 public static <U> CompletionStage<U> failedStage(Throwable ex) {
2780 if (ex == null) throw new NullPointerException();
2781 return new MinimalStage<U>(new AltResult(ex));
2782 }
2783
2784 /**
2785 * Singleton delay scheduler, used only for starting and
2786 * cancelling tasks.
2787 */
2788 static final class Delayer {
2789 static ScheduledFuture<?> delay(Runnable command, long delay,
2790 TimeUnit unit) {
2791 return delayer.schedule(command, delay, unit);
2792 }
2793
2794 static final class DaemonThreadFactory implements ThreadFactory {
2795 public Thread newThread(Runnable r) {
2796 Thread t = new Thread(r);
2797 t.setDaemon(true);
2798 t.setName("CompletableFutureDelayScheduler");
2799 return t;
2800 }
2801 }
2802
2803 static final ScheduledThreadPoolExecutor delayer;
2804 static {
2805 (delayer = new ScheduledThreadPoolExecutor(
2806 1, new DaemonThreadFactory())).
2807 setRemoveOnCancelPolicy(true);
2808 }
2809 }
2810
2811 // Little class-ified lambdas to better support monitoring
2812
2813 static final class DelayedExecutor implements Executor {
2814 final long delay;
2815 final TimeUnit unit;
2816 final Executor executor;
2817 DelayedExecutor(long delay, TimeUnit unit, Executor executor) {
2818 this.delay = delay; this.unit = unit; this.executor = executor;
2819 }
2820 public void execute(Runnable r) {
2821 Delayer.delay(new TaskSubmitter(executor, r), delay, unit);
2822 }
2823 }
2824
2825 /** Action to submit user task */
2826 static final class TaskSubmitter implements Runnable {
2827 final Executor executor;
2828 final Runnable action;
2829 TaskSubmitter(Executor executor, Runnable action) {
2830 this.executor = executor;
2831 this.action = action;
2832 }
2833 public void run() { executor.execute(action); }
2834 }
2835
2836 /** Action to completeExceptionally on timeout */
2837 static final class Timeout implements Runnable {
2838 final CompletableFuture<?> f;
2839 Timeout(CompletableFuture<?> f) { this.f = f; }
2840 public void run() {
2841 if (f != null && !f.isDone())
2842 f.completeExceptionally(new TimeoutException());
2843 }
2844 }
2845
2846 /** Action to complete on timeout */
2847 static final class DelayedCompleter<U> implements Runnable {
2848 final CompletableFuture<U> f;
2849 final U u;
2850 DelayedCompleter(CompletableFuture<U> f, U u) { this.f = f; this.u = u; }
2851 public void run() {
2852 if (f != null)
2853 f.complete(u);
2854 }
2855 }
2856
2857 /** Action to cancel unneeded timeouts */
2858 static final class Canceller implements BiConsumer<Object, Throwable> {
2859 final Future<?> f;
2860 Canceller(Future<?> f) { this.f = f; }
2861 public void accept(Object ignore, Throwable ex) {
2862 if (ex == null && f != null && !f.isDone())
2863 f.cancel(false);
2864 }
2865 }
2866
2867 /**
2868 * A subclass that just throws UOE for most non-CompletionStage methods.
2869 */
2870 static final class MinimalStage<T> extends CompletableFuture<T> {
2871 MinimalStage() { }
2872 MinimalStage(Object r) { super(r); }
2873 @Override public <U> CompletableFuture<U> newIncompleteFuture() {
2874 return new MinimalStage<U>(); }
2875 @Override public T get() {
2876 throw new UnsupportedOperationException(); }
2877 @Override public T get(long timeout, TimeUnit unit) {
2878 throw new UnsupportedOperationException(); }
2879 @Override public T getNow(T valueIfAbsent) {
2880 throw new UnsupportedOperationException(); }
2881 @Override public T join() {
2882 throw new UnsupportedOperationException(); }
2883 @Override public boolean complete(T value) {
2884 throw new UnsupportedOperationException(); }
2885 @Override public boolean completeExceptionally(Throwable ex) {
2886 throw new UnsupportedOperationException(); }
2887 @Override public boolean cancel(boolean mayInterruptIfRunning) {
2888 throw new UnsupportedOperationException(); }
2889 @Override public void obtrudeValue(T value) {
2890 throw new UnsupportedOperationException(); }
2891 @Override public void obtrudeException(Throwable ex) {
2892 throw new UnsupportedOperationException(); }
2893 @Override public boolean isDone() {
2894 throw new UnsupportedOperationException(); }
2895 @Override public boolean isCancelled() {
2896 throw new UnsupportedOperationException(); }
2897 @Override public boolean isCompletedExceptionally() {
2898 throw new UnsupportedOperationException(); }
2899 @Override public int getNumberOfDependents() {
2900 throw new UnsupportedOperationException(); }
2901 @Override public CompletableFuture<T> completeAsync
2902 (Supplier<? extends T> supplier, Executor executor) {
2903 throw new UnsupportedOperationException(); }
2904 @Override public CompletableFuture<T> completeAsync
2905 (Supplier<? extends T> supplier) {
2906 throw new UnsupportedOperationException(); }
2907 @Override public CompletableFuture<T> orTimeout
2908 (long timeout, TimeUnit unit) {
2909 throw new UnsupportedOperationException(); }
2910 @Override public CompletableFuture<T> completeOnTimeout
2911 (T value, long timeout, TimeUnit unit) {
2912 throw new UnsupportedOperationException(); }
2913 @Override public CompletableFuture<T> toCompletableFuture() {
2914 Object r;
2915 if ((r = result) != null)
2916 return new CompletableFuture<T>(encodeRelay(r));
2917 else {
2918 CompletableFuture<T> d = new CompletableFuture<>();
2919 unipush(new UniRelay<T,T>(d, this));
2920 return d;
2921 }
2922 }
2923 }
2924
2925 // VarHandle mechanics
2926 private static final VarHandle RESULT;
2927 private static final VarHandle STACK;
2928 private static final VarHandle NEXT;
2929 static {
2930 try {
2931 MethodHandles.Lookup l = MethodHandles.lookup();
2932 RESULT = l.findVarHandle(CompletableFuture.class, "result", Object.class);
2933 STACK = l.findVarHandle(CompletableFuture.class, "stack", Completion.class);
2934 NEXT = l.findVarHandle(Completion.class, "next", Completion.class);
2935 } catch (ReflectiveOperationException e) {
2936 throw new ExceptionInInitializerError(e);
2937 }
2938
2939 // Reduce the risk of rare disastrous classloading in first call to
2940 // LockSupport.park: https://bugs.openjdk.java.net/browse/JDK-8074773
2941 Class<?> ensureLoaded = LockSupport.class;
2942 }
2943 }