ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/jsr166y/ForkJoinTask.java
(Generate patch)

Comparing jsr166/src/jsr166y/ForkJoinTask.java (file contents):
Revision 1.29 by jsr166, Sun Aug 2 17:19:24 2009 UTC vs.
Revision 1.36 by dl, Tue Aug 4 13:16:54 2009 UTC

# Line 12 | Line 12 | import java.io.Serializable;
12   import java.util.Collection;
13   import java.util.Collections;
14   import java.util.List;
15 + import java.util.RandomAccess;
16   import java.util.Map;
17   import java.util.WeakHashMap;
18  
# Line 54 | Line 55 | import java.util.WeakHashMap;
55   * restriction is in part enforced by not permitting checked
56   * exceptions such as {@code IOExceptions} to be thrown. However,
57   * computations may still encounter unchecked exceptions, that are
58 < * rethrown to callers attempting join them. These exceptions may
58 > * rethrown to callers attempting to join them. These exceptions may
59   * additionally include RejectedExecutionExceptions stemming from
60   * internal resource exhaustion such as failure to allocate internal
61   * task queues.
# Line 67 | Line 68 | import java.util.WeakHashMap;
68   * execute other tasks while awaiting joins, which is sometimes more
69   * efficient but only applies when all subtasks are known to be
70   * strictly tree-structured. Method {@link #invoke} is semantically
71 < * equivalent to {@code fork(); join()} but always attempts to
72 < * begin execution in the current thread. The "<em>quiet</em>" forms
73 < * of these methods do not extract results or report exceptions. These
71 > * equivalent to {@code fork(); join()} but always attempts to begin
72 > * execution in the current thread. The "<em>quiet</em>" forms of
73 > * these methods do not extract results or report exceptions. These
74   * may be useful when a set of tasks are being executed, and you need
75   * to delay processing of results or exceptions until all complete.
76   * Method {@code invokeAll} (available in multiple versions)
77   * performs the most common form of parallel invocation: forking a set
78   * of tasks and joining them all.
79   *
80 + * <p>The execution status of tasks may be queried at several levels
81 + * of detail: {@link #isDone} is true if a task completed in any way
82 + * (including the case where a task was cancelled without executing);
83 + * {@link #isCancelled} is true if completion was due to cancellation;
84 + * {@link #isCompletedNormally} is true if a task completed without
85 + * cancellation or encountering an exception; {@link
86 + * #isCompletedExceptionally} is true if if the task encountered an
87 + * exception (in which case {@link #getException} returns the
88 + * exception); {@link #isCancelled} is true if the task was cancelled
89 + * (in which case {@link #getException} returns a {@link
90 + * java.util.concurrent.CancellationException}); and {@link
91 + * #isCompletedAbnormally} is true if a task was either cancelled or
92 + * encountered an exception.
93 + *
94   * <p>The ForkJoinTask class is not usually directly subclassed.
95   * Instead, you subclass one of the abstract classes that support a
96   * particular style of fork/join processing, typically {@link
# Line 85 | Line 100 | import java.util.WeakHashMap;
100   * established in a constructor, and then defines a {@code compute}
101   * method that somehow uses the control methods supplied by this base
102   * class. While these methods have {@code public} access (to allow
103 < * instances of different task subclasses to call each others
103 > * instances of different task subclasses to call each other's
104   * methods), some of them may only be called from within other
105   * ForkJoinTasks (as may be determined using method {@link
106   * #inForkJoinPool}).  Attempts to invoke them in other contexts
107   * result in exceptions or errors, possibly including
108   * ClassCastException.
109   *
110 < * <p>Most base support methods are {@code final} because their
111 < * implementations are intrinsically tied to the underlying
112 < * lightweight task scheduling framework, and so cannot be overridden.
113 < * Developers creating new basic styles of fork/join processing should
114 < * minimally implement {@code protected} methods
115 < * {@link #exec}, {@link #setRawResult}, and
116 < * {@link #getRawResult}, while also introducing an abstract
117 < * computational method that can be implemented in its subclasses,
118 < * possibly relying on other {@code protected} methods provided
104 < * by this class.
110 > * <p>Most base support methods are {@code final}, to prevent
111 > * overriding of implementations that are intrinsically tied to the
112 > * underlying lightweight task scheduling framework.  Developers
113 > * creating new basic styles of fork/join processing should minimally
114 > * implement {@code protected} methods {@link #exec}, {@link
115 > * #setRawResult}, and {@link #getRawResult}, while also introducing
116 > * an abstract computational method that can be implemented in its
117 > * subclasses, possibly relying on other {@code protected} methods
118 > * provided by this class.
119   *
120   * <p>ForkJoinTasks should perform relatively small amounts of
121 < * computations, otherwise splitting into smaller tasks. As a very
122 < * rough rule of thumb, a task should perform more than 100 and less
123 < * than 10000 basic computational steps. If tasks are too big, then
124 < * parallelism cannot improve throughput. If too small, then memory
125 < * and internal task maintenance overhead may overwhelm processing.
121 > * computation. Large tasks should be split into smaller subtasks,
122 > * usually via recursive decomposition. As a very rough rule of thumb,
123 > * a task should perform more than 100 and less than 10000 basic
124 > * computational steps. If tasks are too big, then parallelism cannot
125 > * improve throughput. If too small, then memory and internal task
126 > * maintenance overhead may overwhelm processing.
127   *
128   * <p>This class provides {@code adapt} methods for {@link
129   * java.lang.Runnable} and {@link java.util.concurrent.Callable}, that
130   * may be of use when mixing execution of ForkJoinTasks with other
131   * kinds of tasks. When all tasks are of this form, consider using a
132 < * pool in {@link ForkJoinPool#setAsyncMode}.
132 > * pool in {@link ForkJoinPool#setAsyncMode async mode}.
133   *
134 < * <p>ForkJoinTasks are {@code Serializable}, which enables them
135 < * to be used in extensions such as remote execution frameworks. It is
136 < * in general sensible to serialize tasks only before or after, but
137 < * not during execution. Serialization is not relied on during
123 < * execution itself.
134 > * <p>ForkJoinTasks are {@code Serializable}, which enables them to be
135 > * used in extensions such as remote execution frameworks. It is
136 > * sensible to serialize tasks only before or after, but not during,
137 > * execution. Serialization is not relied on during execution itself.
138   *
139   * @since 1.7
140   * @author Doug Lea
# Line 382 | Line 396 | public abstract class ForkJoinTask<V> im
396       */
397      private V reportFutureResult()
398          throws ExecutionException, InterruptedException {
399 +        if (Thread.interrupted())
400 +            throw new InterruptedException();
401          int s = status & COMPLETION_MASK;
402          if (s < NORMAL) {
403              Throwable ex;
# Line 389 | Line 405 | public abstract class ForkJoinTask<V> im
405                  throw new CancellationException();
406              if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
407                  throw new ExecutionException(ex);
392            if (Thread.interrupted())
393                throw new InterruptedException();
408          }
409          return getRawResult();
410      }
# Line 401 | Line 415 | public abstract class ForkJoinTask<V> im
415       */
416      private V reportTimedFutureResult()
417          throws InterruptedException, ExecutionException, TimeoutException {
418 +        if (Thread.interrupted())
419 +            throw new InterruptedException();
420          Throwable ex;
421          int s = status & COMPLETION_MASK;
422          if (s == NORMAL)
# Line 409 | Line 425 | public abstract class ForkJoinTask<V> im
425              throw new CancellationException();
426          if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
427              throw new ExecutionException(ex);
412        if (Thread.interrupted())
413            throw new InterruptedException();
428          throw new TimeoutException();
429      }
430  
# Line 496 | Line 510 | public abstract class ForkJoinTask<V> im
510      /**
511       * Arranges to asynchronously execute this task.  While it is not
512       * necessarily enforced, it is a usage error to fork a task more
513 <     * than once unless it has completed and been reinitialized.  This
500 <     * method may be invoked only from within ForkJoinTask
501 <     * computations (as may be determined using method {@link
502 <     * #inForkJoinPool}). Attempts to invoke in other contexts result
503 <     * in exceptions or errors, possibly including ClassCastException.
513 >     * than once unless it has completed and been reinitialized.
514       *
515 <     * @return {@code this}, to simplify usage.
515 >     * <p>This method may be invoked only from within {@code
516 >     * ForkJoinTask} computations (as may be determined using method
517 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
518 >     * result in exceptions or errors, possibly including {@code
519 >     * ClassCastException}.
520 >     *
521 >     * @return {@code this}, to simplify usage
522       */
523      public final ForkJoinTask<V> fork() {
524          ((ForkJoinWorkerThread) Thread.currentThread())
# Line 512 | Line 528 | public abstract class ForkJoinTask<V> im
528  
529      /**
530       * Returns the result of the computation when it is ready.
531 <     * This method differs from {@code get} in that abnormal
532 <     * completion results in RuntimeExceptions or Errors, not
533 <     * ExecutionExceptions.
531 >     * This method differs from {@link #get()} in that
532 >     * abnormal completion results in {@code RuntimeException} or
533 >     * {@code Error}, not {@code ExecutionException}.
534       *
535       * @return the computed result
536       */
# Line 527 | Line 543 | public abstract class ForkJoinTask<V> im
543  
544      /**
545       * Commences performing this task, awaits its completion if
546 <     * necessary, and return its result.
546 >     * necessary, and return its result, or throws an (unchecked)
547 >     * exception if the underlying computation did so.
548       *
532     * @throws Throwable (a RuntimeException, Error, or unchecked
533     * exception) if the underlying computation did so
549       * @return the computed result
550       */
551      public final V invoke() {
# Line 542 | Line 557 | public abstract class ForkJoinTask<V> im
557  
558      /**
559       * Forks the given tasks, returning when {@code isDone} holds for
560 <     * each task or an exception is encountered. This method may be
561 <     * invoked only from within ForkJoinTask computations (as may be
562 <     * determined using method {@link #inForkJoinPool}). Attempts to
563 <     * invoke in other contexts result in exceptions or errors,
564 <     * possibly including ClassCastException.
560 >     * each task or an (unchecked) exception is encountered, in which
561 >     * case the exception is rethrown.  If more than one task
562 >     * encounters an exception, then this method throws any one of
563 >     * these exceptions.  The individual status of each task may be
564 >     * checked using {@link #getException()} and related methods.
565 >     *
566 >     * <p>This method may be invoked only from within {@code
567 >     * ForkJoinTask} computations (as may be determined using method
568 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
569 >     * result in exceptions or errors, possibly including {@code
570 >     * ClassCastException}.
571       *
572       * @param t1 the first task
573       * @param t2 the second task
574       * @throws NullPointerException if any task is null
554     * @throws RuntimeException or Error if a task did so
575       */
576 <    public static void invokeAll(ForkJoinTask<?>t1, ForkJoinTask<?> t2) {
576 >    public static void invokeAll(ForkJoinTask<?> t1, ForkJoinTask<?> t2) {
577          t2.fork();
578          t1.invoke();
579          t2.join();
# Line 561 | Line 581 | public abstract class ForkJoinTask<V> im
581  
582      /**
583       * Forks the given tasks, returning when {@code isDone} holds for
584 <     * each task or an exception is encountered. If any task
585 <     * encounters an exception, others may be, but are not guaranteed
586 <     * to be, cancelled.  This method may be invoked only from within
587 <     * ForkJoinTask computations (as may be determined using method
588 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
589 <     * result in exceptions or errors, possibly including
590 <     * ClassCastException.
591 <     *
592 <     * Overloadings of this method exist for the special cases
593 <     * of one to four arguments.
584 >     * each task or an (unchecked) exception is encountered, in which
585 >     * case the exception is rethrown. If any task encounters an
586 >     * exception, others may be, but are not guaranteed to be,
587 >     * cancelled.  If more than one task encounters an exception, then
588 >     * this method throws any one of these exceptions.  The individual
589 >     * status of each task may be checked using {@link #getException()}
590 >     * and related methods.
591 >     *
592 >     * <p>This method may be invoked only from within {@code
593 >     * ForkJoinTask} computations (as may be determined using method
594 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
595 >     * result in exceptions or errors, possibly including {@code
596 >     * ClassCastException}.
597       *
598       * @param tasks the tasks
599 <     * @throws NullPointerException if tasks or any element are null
577 <     * @throws RuntimeException or Error if any task did so
599 >     * @throws NullPointerException if any task is null
600       */
601      public static void invokeAll(ForkJoinTask<?>... tasks) {
602          Throwable ex = null;
# Line 610 | Line 632 | public abstract class ForkJoinTask<V> im
632      }
633  
634      /**
635 <     * Forks all tasks in the collection, returning when {@code
636 <     * isDone} holds for each task or an exception is encountered. If
637 <     * any task encounters an exception, others may be, but are not
638 <     * guaranteed to be, cancelled.  This method may be invoked only
639 <     * from within ForkJoinTask computations (as may be determined
640 <     * using method {@link #inForkJoinPool}). Attempts to invoke in
641 <     * other contexts result in exceptions or errors, possibly
642 <     * including ClassCastException.
635 >     * Forks all tasks in the specified collection, returning when
636 >     * {@code isDone} holds for each task or an (unchecked) exception
637 >     * is encountered.  If any task encounters an exception, others
638 >     * may be, but are not guaranteed to be, cancelled.  If more than
639 >     * one task encounters an exception, then this method throws any
640 >     * one of these exceptions.  The individual status of each task
641 >     * may be checked using {@link #getException()} and related
642 >     * methods.  The behavior of this operation is undefined if the
643 >     * specified collection is modified while the operation is in
644 >     * progress.
645 >     *
646 >     * <p>This method may be invoked only from within {@code
647 >     * ForkJoinTask} computations (as may be determined using method
648 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
649 >     * result in exceptions or errors, possibly including {@code
650 >     * ClassCastException}.
651       *
652       * @param tasks the collection of tasks
653       * @return the tasks argument, to simplify usage
654       * @throws NullPointerException if tasks or any element are null
625     * @throws RuntimeException or Error if any task did so
655       */
656      public static <T extends ForkJoinTask<?>> Collection<T> invokeAll(Collection<T> tasks) {
657 <        if (!(tasks instanceof List<?>)) {
657 >        if (!(tasks instanceof RandomAccess) || !(tasks instanceof List<?>)) {
658              invokeAll(tasks.toArray(new ForkJoinTask<?>[tasks.size()]));
659              return tasks;
660          }
# Line 666 | Line 695 | public abstract class ForkJoinTask<V> im
695      }
696  
697      /**
698 <     * Returns {@code true} if the computation performed by this task
699 <     * has completed (or has been cancelled).
700 <     *
701 <     * @return {@code true} if this computation has completed
702 <     */
703 <    public final boolean isDone() {
704 <        return status < 0;
676 <    }
677 <
678 <    /**
679 <     * Returns {@code true} if this task was cancelled.
680 <     *
681 <     * @return {@code true} if this task was cancelled
682 <     */
683 <    public final boolean isCancelled() {
684 <        return (status & COMPLETION_MASK) == CANCELLED;
685 <    }
686 <
687 <    /**
688 <     * Asserts that the results of this task's computation will not be
689 <     * used. If a cancellation occurs before attempting to execute this
690 <     * task, execution will be suppressed, {@link #isCancelled}
691 <     * will report true, and {@link #join} will result in a
692 <     * {@code CancellationException} being thrown. Otherwise, when
693 <     * cancellation races with completion, there are no guarantees
694 <     * about whether {@code isCancelled} will report {@code true},
695 <     * whether {@code join} will return normally or via an exception,
696 <     * or whether these behaviors will remain consistent upon repeated
697 <     * invocation.
698 >     * Attempts to cancel execution of this task. This attempt will
699 >     * fail if the task has already completed, has already been
700 >     * cancelled, or could not be cancelled for some other reason. If
701 >     * successful, and this task has not started when cancel is
702 >     * called, execution of this task is suppressed, {@link
703 >     * #isCancelled} will report true, and {@link #join} will result
704 >     * in a {@code CancellationException} being thrown.
705       *
706       * <p>This method may be overridden in subclasses, but if so, must
707       * still ensure that these minimal properties hold. In particular,
# Line 706 | Line 713 | public abstract class ForkJoinTask<V> im
713       * invoke {@link #completeExceptionally}.
714       *
715       * @param mayInterruptIfRunning this value is ignored in the
716 <     * default implementation because tasks are not in general
716 >     * default implementation because tasks are not
717       * cancelled via interruption
718       *
719       * @return {@code true} if this task is now cancelled
# Line 717 | Line 724 | public abstract class ForkJoinTask<V> im
724      }
725  
726      /**
727 +     * Returns {@code true} if the computation performed by this task
728 +     * has completed (or has been cancelled).
729 +     *
730 +     * @return {@code true} if this computation has completed
731 +     */
732 +    public final boolean isDone() {
733 +        return status < 0;
734 +    }
735 +
736 +    /**
737 +     * Returns {@code true} if this task was cancelled.
738 +     *
739 +     * @return {@code true} if this task was cancelled
740 +     */
741 +    public final boolean isCancelled() {
742 +        return (status & COMPLETION_MASK) == CANCELLED;
743 +    }
744 +
745 +    /**
746       * Returns {@code true} if this task threw an exception or was cancelled.
747       *
748       * @return {@code true} if this task threw an exception or was cancelled
# Line 726 | Line 752 | public abstract class ForkJoinTask<V> im
752      }
753  
754      /**
755 +     * Returns {@code true} if this task completed without throwing an
756 +     * exception and was not cancelled.
757 +     *
758 +     * @return {@code true} if this task completed without throwing an
759 +     * exception and was not cancelled
760 +     */
761 +    public final boolean isCompletedNormally() {
762 +        return (status & COMPLETION_MASK) == NORMAL;
763 +    }
764 +
765 +    /**
766 +     * Returns {@code true} if this task threw an exception.
767 +     *
768 +     * @return {@code true} if this task threw an exception
769 +     */
770 +    public final boolean isCompletedExceptionally() {
771 +        return (status & COMPLETION_MASK) == EXCEPTIONAL;
772 +    }
773 +
774 +    /**
775       * Returns the exception thrown by the base computation, or a
776       * {@code CancellationException} if cancelled, or {@code null} if
777       * none or if the method has not yet completed.
# Line 806 | Line 852 | public abstract class ForkJoinTask<V> im
852       * there are no potential dependencies between continuation of the
853       * current task and that of any other task that might be executed
854       * while helping. (This usually holds for pure divide-and-conquer
855 <     * tasks). This method may be invoked only from within
856 <     * ForkJoinTask computations (as may be determined using method
857 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
858 <     * result in exceptions or errors, possibly including
859 <     * ClassCastException.
855 >     * tasks).
856 >     *
857 >     * <p>This method may be invoked only from within {@code
858 >     * ForkJoinTask} computations (as may be determined using method
859 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
860 >     * result in exceptions or errors, possibly including {@code
861 >     * ClassCastException}.
862       *
863       * @return the computed result
864       */
# Line 823 | Line 871 | public abstract class ForkJoinTask<V> im
871  
872      /**
873       * Possibly executes other tasks until this task is ready.  This
874 <     * method may be invoked only from within ForkJoinTask
875 <     * computations (as may be determined using method {@link
876 <     * #inForkJoinPool}). Attempts to invoke in other contexts result
877 <     * in exceptions or errors, possibly including ClassCastException.
874 >     * method may be useful when processing collections of tasks when
875 >     * some have been cancelled or otherwise known to have aborted.
876 >     *
877 >     * <p>This method may be invoked only from within {@code
878 >     * ForkJoinTask} computations (as may be determined using method
879 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
880 >     * result in exceptions or errors, possibly including {@code
881 >     * ClassCastException}.
882       */
883      public final void quietlyHelpJoin() {
884          if (status >= 0) {
# Line 865 | Line 917 | public abstract class ForkJoinTask<V> im
917  
918      /**
919       * Possibly executes tasks until the pool hosting the current task
920 <     * {@link ForkJoinPool#isQuiescent}. This method may be of use in
921 <     * designs in which many tasks are forked, but none are explicitly
922 <     * joined, instead executing them until all are processed.  This
923 <     * method may be invoked only from within ForkJoinTask
924 <     * computations (as may be determined using method {@link
925 <     * #inForkJoinPool}). Attempts to invoke in other contexts result
926 <     * in exceptions or errors, possibly including ClassCastException.
920 >     * {@link ForkJoinPool#isQuiescent is quiescent}. This method may
921 >     * be of use in designs in which many tasks are forked, but none
922 >     * are explicitly joined, instead executing them until all are
923 >     * processed.
924 >     *
925 >     * <p>This method may be invoked only from within {@code
926 >     * ForkJoinTask} computations (as may be determined using method
927 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
928 >     * result in exceptions or errors, possibly including {@code
929 >     * ClassCastException}.
930       */
931      public static void helpQuiesce() {
932          ((ForkJoinWorkerThread) Thread.currentThread())
# Line 884 | Line 939 | public abstract class ForkJoinTask<V> im
939       * this task, but only if reuse occurs when this task has either
940       * never been forked, or has been forked, then completed and all
941       * outstanding joins of this task have also completed. Effects
942 <     * under any other usage conditions are not guaranteed, and are
943 <     * discouraged. This method may be useful when executing
942 >     * under any other usage conditions are not guaranteed.
943 >     * This method may be useful when executing
944       * pre-constructed trees of subtasks in loops.
945       */
946      public void reinitialize() {
# Line 924 | Line 979 | public abstract class ForkJoinTask<V> im
979       * by the current thread, and has not commenced executing in
980       * another thread.  This method may be useful when arranging
981       * alternative local processing of tasks that could have been, but
982 <     * were not, stolen. This method may be invoked only from within
983 <     * ForkJoinTask computations (as may be determined using method
984 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
985 <     * result in exceptions or errors, possibly including
986 <     * ClassCastException.
982 >     * were not, stolen.
983 >     *
984 >     * <p>This method may be invoked only from within {@code
985 >     * ForkJoinTask} computations (as may be determined using method
986 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
987 >     * result in exceptions or errors, possibly including {@code
988 >     * ClassCastException}.
989       *
990       * @return {@code true} if unforked
991       */
# Line 941 | Line 998 | public abstract class ForkJoinTask<V> im
998       * Returns an estimate of the number of tasks that have been
999       * forked by the current worker thread but not yet executed. This
1000       * value may be useful for heuristic decisions about whether to
1001 <     * fork other tasks.  This method may be invoked only from within
1002 <     * ForkJoinTask computations (as may be determined using method
1003 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
1004 <     * result in exceptions or errors, possibly including
1005 <     * ClassCastException.
1001 >     * fork other tasks.
1002 >     *
1003 >     * <p>This method may be invoked only from within {@code
1004 >     * ForkJoinTask} computations (as may be determined using method
1005 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1006 >     * result in exceptions or errors, possibly including {@code
1007 >     * ClassCastException}.
1008 >     *
1009       * @return the number of tasks
1010       */
1011      public static int getQueuedTaskCount() {
# Line 961 | Line 1021 | public abstract class ForkJoinTask<V> im
1021       * usages of ForkJoinTasks, at steady state, each worker should
1022       * aim to maintain a small constant surplus (for example, 3) of
1023       * tasks, and to process computations locally if this threshold is
1024 <     * exceeded.  This method may be invoked only from within
1025 <     * ForkJoinTask computations (as may be determined using method
1026 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
1027 <     * result in exceptions or errors, possibly including
1028 <     * ClassCastException.  *
1024 >     * exceeded.
1025 >     *
1026 >     * <p>This method may be invoked only from within {@code
1027 >     * ForkJoinTask} computations (as may be determined using method
1028 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1029 >     * result in exceptions or errors, possibly including {@code
1030 >     * ClassCastException}.
1031 >     *
1032       * @return the surplus number of tasks, which may be negative
1033       */
1034      public static int getSurplusQueuedTaskCount() {
# Line 1001 | Line 1064 | public abstract class ForkJoinTask<V> im
1064       * called otherwise. The return value controls whether this task
1065       * is considered to be done normally. It may return false in
1066       * asynchronous actions that require explicit invocations of
1067 <     * {@link #complete} to become joinable. It may throw exceptions
1068 <     * to indicate abnormal exit.
1067 >     * {@link #complete} to become joinable. It may also throw an
1068 >     * (unchecked) exception to indicate abnormal exit.
1069       *
1070       * @return {@code true} if completed normally
1008     * @throws Error or RuntimeException if encountered during computation
1071       */
1072      protected abstract boolean exec();
1073  
# Line 1017 | Line 1079 | public abstract class ForkJoinTask<V> im
1079       * null even if a task exists but cannot be accessed without
1080       * contention with other threads.  This method is designed
1081       * primarily to support extensions, and is unlikely to be useful
1082 <     * otherwise.  This method may be invoked only from within
1083 <     * ForkJoinTask computations (as may be determined using method
1084 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
1085 <     * result in exceptions or errors, possibly including
1086 <     * ClassCastException.
1082 >     * otherwise.
1083 >     *
1084 >     * <p>This method may be invoked only from within {@code
1085 >     * ForkJoinTask} computations (as may be determined using method
1086 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1087 >     * result in exceptions or errors, possibly including {@code
1088 >     * ClassCastException}.
1089       *
1090       * @return the next task, or {@code null} if none are available
1091       */
# Line 1034 | Line 1098 | public abstract class ForkJoinTask<V> im
1098       * Unschedules and returns, without executing, the next task
1099       * queued by the current thread but not yet executed.  This method
1100       * is designed primarily to support extensions, and is unlikely to
1101 <     * be useful otherwise.  This method may be invoked only from
1102 <     * within ForkJoinTask computations (as may be determined using
1103 <     * method {@link #inForkJoinPool}). Attempts to invoke in other
1104 <     * contexts result in exceptions or errors, possibly including
1105 <     * ClassCastException.
1101 >     * be useful otherwise.
1102 >     *
1103 >     * <p>This method may be invoked only from within {@code
1104 >     * ForkJoinTask} computations (as may be determined using method
1105 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1106 >     * result in exceptions or errors, possibly including {@code
1107 >     * ClassCastException}.
1108       *
1109       * @return the next task, or {@code null} if none are available
1110       */
# Line 1055 | Line 1121 | public abstract class ForkJoinTask<V> im
1121       * {@code null} result does not necessarily imply quiescence
1122       * of the pool this task is operating in.  This method is designed
1123       * primarily to support extensions, and is unlikely to be useful
1124 <     * otherwise.  This method may be invoked only from within
1125 <     * ForkJoinTask computations (as may be determined using method
1126 <     * {@link #inForkJoinPool}). Attempts to invoke in other contexts
1127 <     * result in exceptions or errors, possibly including
1128 <     * ClassCastException.
1124 >     * otherwise.
1125 >     *
1126 >     * <p>This method may be invoked only from within {@code
1127 >     * ForkJoinTask} computations (as may be determined using method
1128 >     * {@link #inForkJoinPool}).  Attempts to invoke in other contexts
1129 >     * result in exceptions or errors, possibly including {@code
1130 >     * ClassCastException}.
1131       *
1132       * @return a task, or {@code null} if none are available
1133       */
# Line 1124 | Line 1192 | public abstract class ForkJoinTask<V> im
1192      }
1193  
1194      /**
1195 <     * Returns a new ForkJoinTask that performs the {@code run}
1196 <     * method of the given Runnable as its action, and returns a null
1197 <     * result upon {@code join}.
1195 >     * Returns a new {@code ForkJoinTask} that performs the {@code run}
1196 >     * method of the given {@code Runnable} as its action, and returns
1197 >     * a null result upon {@link #join}.
1198       *
1199       * @param runnable the runnable action
1200       * @return the task
# Line 1136 | Line 1204 | public abstract class ForkJoinTask<V> im
1204      }
1205  
1206      /**
1207 <     * Returns a new ForkJoinTask that performs the {@code run}
1208 <     * method of the given Runnable as its action, and returns the
1209 <     * given result upon {@code join}.
1207 >     * Returns a new {@code ForkJoinTask} that performs the {@code run}
1208 >     * method of the given {@code Runnable} as its action, and returns
1209 >     * the given result upon {@link #join}.
1210       *
1211       * @param runnable the runnable action
1212       * @param result the result upon completion
# Line 1149 | Line 1217 | public abstract class ForkJoinTask<V> im
1217      }
1218  
1219      /**
1220 <     * Returns a new ForkJoinTask that performs the {@code call}
1221 <     * method of the given Callable as its action, and returns its
1222 <     * result upon {@code join}, translating any checked
1223 <     * exceptions encountered into {@code RuntimeException}.
1220 >     * Returns a new {@code ForkJoinTask} that performs the {@code call}
1221 >     * method of the given {@code Callable} as its action, and returns
1222 >     * its result upon {@link #join}, translating any checked exceptions
1223 >     * encountered into {@code RuntimeException}.
1224       *
1225       * @param callable the callable action
1226       * @return the task

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines