10 |
|
* Recursive resultless ForkJoinTasks. This class establishes |
11 |
|
* conventions to parameterize resultless actions as {@code Void} |
12 |
|
* ForkJoinTasks. Because {@code null} is the only valid value of |
13 |
< |
* {@code Void}, methods such as join always return {@code null} |
13 |
> |
* type {@code Void}, methods such as join always return {@code null} |
14 |
|
* upon completion. |
15 |
|
* |
16 |
|
* <p><b>Sample Usages.</b> Here is a sketch of a ForkJoin sort that |
34 |
|
* } |
35 |
|
* }}</pre> |
36 |
|
* |
37 |
< |
* You could then sort anArray by creating {@code new SortTask(anArray, 0, |
38 |
< |
* anArray.length-1) } and invoking it in a ForkJoinPool. |
39 |
< |
* As a more concrete simple example, the following task increments |
40 |
< |
* each element of an array: |
37 |
> |
* You could then sort {@code anArray} by creating {@code new |
38 |
> |
* SortTask(anArray, 0, anArray.length-1) } and invoking it in a |
39 |
> |
* ForkJoinPool. As a more concrete simple example, the following |
40 |
> |
* task increments each element of an array: |
41 |
|
* <pre> {@code |
42 |
|
* class IncrementTask extends RecursiveAction { |
43 |
|
* final long[] array; final int lo; final int hi; |
98 |
|
* int l = lo; |
99 |
|
* int h = hi; |
100 |
|
* Applyer right = null; |
101 |
< |
* while (h - l > 1 && |
102 |
< |
* ForkJoinWorkerThread.getEstimatedSurplusTaskCount() <= 3) { |
101 |
> |
* while (h - l > 1 && getSurplusQueuedTaskCount() <= 3) { |
102 |
|
* int mid = (l + h) >>> 1; |
103 |
|
* right = new Applyer(array, mid, h, seqSize, right); |
104 |
|
* right.fork(); |
117 |
|
* result = sum; |
118 |
|
* } |
119 |
|
* }}</pre> |
120 |
+ |
* |
121 |
+ |
* @since 1.7 |
122 |
+ |
* @author Doug Lea |
123 |
|
*/ |
124 |
|
public abstract class RecursiveAction extends ForkJoinTask<Void> { |
125 |
|
|
129 |
|
protected abstract void compute(); |
130 |
|
|
131 |
|
/** |
132 |
< |
* Always returns null |
132 |
> |
* Always returns null. |
133 |
|
*/ |
134 |
|
public final Void getRawResult() { return null; } |
135 |
|
|
139 |
|
protected final void setRawResult(Void mustBeNull) { } |
140 |
|
|
141 |
|
/** |
142 |
< |
* Implements execution conventions for RecursiveActions |
142 |
> |
* Implements execution conventions for RecursiveActions. |
143 |
|
*/ |
144 |
|
protected final boolean exec() { |
145 |
|
compute(); |