56 |
|
* exceptions such as {@code IOExceptions} to be thrown. However, |
57 |
|
* computations may still encounter unchecked exceptions, that are |
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. |
59 |
> |
* additionally include {@link RejectedExecutionException} stemming |
60 |
> |
* from internal resource exhaustion, such as failure to allocate |
61 |
> |
* internal task queues. |
62 |
|
* |
63 |
|
* <p>The primary method for awaiting completion and extracting |
64 |
|
* results of a task is {@link #join}, but there are several variants: |
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 |
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. |
514 |
+ |
* Subsequent modifications to the state of this task or any data |
515 |
+ |
* it operates on are not necessarily consistently observable by |
516 |
+ |
* any thread other than the one executing it unless preceded by a |
517 |
+ |
* call to {@link #join} or related methods, or a call to {@link |
518 |
+ |
* #isDone} returning {@code true}. |
519 |
|
* |
520 |
|
* <p>This method may be invoked only from within {@code |
521 |
|
* ForkJoinTask} computations (as may be determined using method |
532 |
|
} |
533 |
|
|
534 |
|
/** |
535 |
< |
* Returns the result of the computation when it is ready. |
535 |
> |
* Returns the result of the computation when it {@link #isDone is done}. |
536 |
|
* This method differs from {@link #get()} in that |
537 |
|
* abnormal completion results in {@code RuntimeException} or |
538 |
|
* {@code Error}, not {@code ExecutionException}. |
729 |
|
return (status & COMPLETION_MASK) == CANCELLED; |
730 |
|
} |
731 |
|
|
729 |
– |
/** |
730 |
– |
* Returns {@code true} if the computation performed by this task |
731 |
– |
* has completed (or has been cancelled). |
732 |
– |
* |
733 |
– |
* @return {@code true} if this computation has completed |
734 |
– |
*/ |
732 |
|
public final boolean isDone() { |
733 |
|
return status < 0; |
734 |
|
} |
735 |
|
|
739 |
– |
/** |
740 |
– |
* Returns {@code true} if this task was cancelled. |
741 |
– |
* |
742 |
– |
* @return {@code true} if this task was cancelled |
743 |
– |
*/ |
736 |
|
public final boolean isCancelled() { |
737 |
|
return (status & COMPLETION_MASK) == CANCELLED; |
738 |
|
} |
758 |
|
} |
759 |
|
|
760 |
|
/** |
769 |
– |
* Returns {@code true} if this task threw an exception. |
770 |
– |
* |
771 |
– |
* @return {@code true} if this task threw an exception |
772 |
– |
*/ |
773 |
– |
public final boolean isCompletedExceptionally() { |
774 |
– |
return (status & COMPLETION_MASK) == EXCEPTIONAL; |
775 |
– |
} |
776 |
– |
|
777 |
– |
/** |
761 |
|
* Returns the exception thrown by the base computation, or a |
762 |
|
* {@code CancellationException} if cancelled, or {@code null} if |
763 |
|
* none or if the method has not yet completed. |
781 |
|
* overridable, but overridden versions must invoke {@code super} |
782 |
|
* implementation to maintain guarantees. |
783 |
|
* |
784 |
< |
* @param ex the exception to throw. If this exception is |
785 |
< |
* not a RuntimeException or Error, the actual exception thrown |
786 |
< |
* will be a RuntimeException with cause ex. |
784 |
> |
* @param ex the exception to throw. If this exception is not a |
785 |
> |
* {@code RuntimeException} or {@code Error}, the actual exception |
786 |
> |
* thrown will be a {@code RuntimeException} with cause {@code ex}. |
787 |
|
*/ |
788 |
|
public void completeExceptionally(Throwable ex) { |
789 |
|
setDoneExceptionally((ex instanceof RuntimeException) || |
830 |
|
} |
831 |
|
|
832 |
|
/** |
833 |
< |
* Possibly executes other tasks until this task is ready, then |
834 |
< |
* returns the result of the computation. This method may be more |
835 |
< |
* efficient than {@code join}, but is only applicable when |
836 |
< |
* there are no potential dependencies between continuation of the |
837 |
< |
* current task and that of any other task that might be executed |
838 |
< |
* while helping. (This usually holds for pure divide-and-conquer |
839 |
< |
* tasks). |
833 |
> |
* Possibly executes other tasks until this task {@link #isDone is |
834 |
> |
* done}, then returns the result of the computation. This method |
835 |
> |
* may be more efficient than {@code join}, but is only applicable |
836 |
> |
* when there are no potential dependencies between continuation |
837 |
> |
* of the current task and that of any other task that might be |
838 |
> |
* executed while helping. (This usually holds for pure |
839 |
> |
* divide-and-conquer tasks). |
840 |
|
* |
841 |
|
* <p>This method may be invoked only from within {@code |
842 |
|
* ForkJoinTask} computations (as may be determined using method |
854 |
|
} |
855 |
|
|
856 |
|
/** |
857 |
< |
* Possibly executes other tasks until this task is ready. This |
858 |
< |
* method may be useful when processing collections of tasks when |
859 |
< |
* some have been cancelled or otherwise known to have aborted. |
857 |
> |
* Possibly executes other tasks until this task {@link #isDone is |
858 |
> |
* done}. This method may be useful when processing collections |
859 |
> |
* of tasks when some have been cancelled or otherwise known to |
860 |
> |
* have aborted. |
861 |
|
* |
862 |
|
* <p>This method may be invoked only from within {@code |
863 |
|
* ForkJoinTask} computations (as may be determined using method |