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.36 by dl, Tue Aug 4 13:16:54 2009 UTC vs.
Revision 1.42 by dl, Thu Aug 6 23:08:50 2009 UTC

# Line 80 | Line 80 | import java.util.WeakHashMap;
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;
83   * {@link #isCompletedNormally} is true if a task completed without
84 < * cancellation or encountering an exception; {@link
85 < * #isCompletedExceptionally} is true if if the task encountered an
86 < * exception (in which case {@link #getException} returns the
87 < * exception); {@link #isCancelled} is true if the task was cancelled
88 < * (in which case {@link #getException} returns a {@link
89 < * java.util.concurrent.CancellationException}); and {@link
90 < * #isCompletedAbnormally} is true if a task was either cancelled or
92 < * encountered an exception.
84 > * cancellation or encountering an exception; {@link #isCancelled} is
85 > * true if the task was cancelled (in which case {@link #getException}
86 > * returns a {@link java.util.concurrent.CancellationException}); and
87 > * {@link #isCompletedAbnormally} is true if a task was either
88 > * cancelled or encountered an exception, in which case {@link
89 > * #getException} will return either the encountered exception or
90 > * {@link java.util.concurrent.CancellationException}.
91   *
92   * <p>The ForkJoinTask class is not usually directly subclassed.
93   * Instead, you subclass one of the abstract classes that support a
# Line 125 | Line 123 | import java.util.WeakHashMap;
123   * improve throughput. If too small, then memory and internal task
124   * maintenance overhead may overwhelm processing.
125   *
126 < * <p>This class provides {@code adapt} methods for {@link
127 < * java.lang.Runnable} and {@link java.util.concurrent.Callable}, that
128 < * may be of use when mixing execution of ForkJoinTasks with other
129 < * kinds of tasks. When all tasks are of this form, consider using a
130 < * pool in {@link ForkJoinPool#setAsyncMode async mode}.
126 > * <p>This class provides {@code adapt} methods for {@link Runnable}
127 > * and {@link Callable}, that may be of use when mixing execution of
128 > * {@code ForkJoinTasks} with other kinds of tasks. When all tasks
129 > * are of this form, consider using a pool in
130 > * {@linkplain ForkJoinPool#setAsyncMode async mode}.
131   *
132   * <p>ForkJoinTasks are {@code Serializable}, which enables them to be
133   * used in extensions such as remote execution frameworks. It is
# Line 392 | Line 390 | public abstract class ForkJoinTask<V> im
390  
391      /**
392       * Returns result or throws exception using j.u.c.Future conventions.
393 <     * Only call when {@code isDone} known to be true.
393 >     * Only call when {@code isDone} known to be true or thread known
394 >     * to be interrupted.
395       */
396      private V reportFutureResult()
397 <        throws ExecutionException, InterruptedException {
397 >        throws InterruptedException, ExecutionException {
398          if (Thread.interrupted())
399              throw new InterruptedException();
400          int s = status & COMPLETION_MASK;
# Line 421 | Line 420 | public abstract class ForkJoinTask<V> im
420          int s = status & COMPLETION_MASK;
421          if (s == NORMAL)
422              return getRawResult();
423 <        if (s == CANCELLED)
423 >        else if (s == CANCELLED)
424              throw new CancellationException();
425 <        if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
425 >        else if (s == EXCEPTIONAL && (ex = exceptionMap.get(this)) != null)
426              throw new ExecutionException(ex);
427 <        throw new TimeoutException();
427 >        else
428 >            throw new TimeoutException();
429      }
430  
431      // internal execution methods
# Line 527 | Line 527 | public abstract class ForkJoinTask<V> im
527      }
528  
529      /**
530 <     * Returns the result of the computation when it is ready.
530 >     * Returns the result of the computation when it {@link #isDone is done}.
531       * This method differs from {@link #get()} in that
532       * abnormal completion results in {@code RuntimeException} or
533       * {@code Error}, not {@code ExecutionException}.
# Line 558 | Line 558 | public abstract class ForkJoinTask<V> im
558      /**
559       * Forks the given tasks, returning when {@code isDone} holds for
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
561 >     * case the exception is rethrown.  If either task encounters an
562 >     * exception, the other one may be, but is not guaranteed to be,
563 >     * cancelled.  If both tasks throw an exception, then this method
564 >     * throws one of them.  The individual status of each task may be
565       * checked using {@link #getException()} and related methods.
566       *
567       * <p>This method may be invoked only from within {@code
# Line 723 | Line 724 | public abstract class ForkJoinTask<V> im
724          return (status & COMPLETION_MASK) == CANCELLED;
725      }
726  
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     */
727      public final boolean isDone() {
728          return status < 0;
729      }
730  
736    /**
737     * Returns {@code true} if this task was cancelled.
738     *
739     * @return {@code true} if this task was cancelled
740     */
731      public final boolean isCancelled() {
732          return (status & COMPLETION_MASK) == CANCELLED;
733      }
# Line 763 | Line 753 | public abstract class ForkJoinTask<V> im
753      }
754  
755      /**
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    /**
756       * Returns the exception thrown by the base computation, or a
757       * {@code CancellationException} if cancelled, or {@code null} if
758       * none or if the method has not yet completed.
# Line 780 | Line 761 | public abstract class ForkJoinTask<V> im
761       */
762      public final Throwable getException() {
763          int s = status & COMPLETION_MASK;
764 <        if (s >= NORMAL)
765 <            return null;
766 <        if (s == CANCELLED)
786 <            return new CancellationException();
787 <        return exceptionMap.get(this);
764 >        return ((s >= NORMAL)    ? null :
765 >                (s == CANCELLED) ? new CancellationException() :
766 >                exceptionMap.get(this));
767      }
768  
769      /**
# Line 846 | Line 825 | public abstract class ForkJoinTask<V> im
825      }
826  
827      /**
828 <     * Possibly executes other tasks until this task is ready, then
829 <     * returns the result of the computation.  This method may be more
830 <     * efficient than {@code join}, but is only applicable when
831 <     * there are no potential dependencies between continuation of the
832 <     * current task and that of any other task that might be executed
833 <     * while helping. (This usually holds for pure divide-and-conquer
834 <     * tasks).
828 >     * Possibly executes other tasks until this task {@link #isDone is
829 >     * done}, then returns the result of the computation.  This method
830 >     * may be more efficient than {@code join}, but is only applicable
831 >     * when there are no potential dependencies between continuation
832 >     * of the current task and that of any other task that might be
833 >     * executed while helping. (This usually holds for pure
834 >     * divide-and-conquer tasks).
835       *
836       * <p>This method may be invoked only from within {@code
837       * ForkJoinTask} computations (as may be determined using method
# Line 870 | Line 849 | public abstract class ForkJoinTask<V> im
849      }
850  
851      /**
852 <     * Possibly executes other tasks until this task is ready.  This
853 <     * method may be useful when processing collections of tasks when
854 <     * some have been cancelled or otherwise known to have aborted.
852 >     * Possibly executes other tasks until this task {@link #isDone is
853 >     * done}.  This method may be useful when processing collections
854 >     * of tasks when some have been cancelled or otherwise known to
855 >     * have aborted.
856       *
857       * <p>This method may be invoked only from within {@code
858       * ForkJoinTask} computations (as may be determined using method

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines