| 17 |
|
* |
| 18 |
|
* <p>Upon construction, a BinaryAsyncAction does not bear any |
| 19 |
|
* linkages. For non-root tasks, links must be established using |
| 20 |
< |
* method <tt>linkSubtasks</tt> before use. |
| 20 |
> |
* method {@link #linkSubtasks} before use. |
| 21 |
|
* |
| 22 |
|
* <p><b>Sample Usage.</b> A version of Fibonacci: |
| 23 |
|
* <pre> |
| 75 |
|
|
| 76 |
|
/** |
| 77 |
|
* Creates a new action. Unless this is a root task, you will need |
| 78 |
< |
* to link it using method <tt>linkSubtasks</tt> before forking as |
| 78 |
> |
* to link it using method {@link #linkSubtasks} before forking as |
| 79 |
|
* a subtask. |
| 80 |
|
*/ |
| 81 |
|
protected BinaryAsyncAction() { |
| 98 |
|
} |
| 99 |
|
|
| 100 |
|
/** |
| 101 |
< |
* Overridable callback action triggered upon <tt>complete</tt> of |
| 101 |
> |
* Overridable callback action triggered upon {@code complete} of |
| 102 |
|
* subtasks. Upon invocation, both subtasks have completed. |
| 103 |
< |
* After return, this task <tt>isDone</tt> and is joinable by |
| 103 |
> |
* After return, this task {@code isDone} and is joinable by |
| 104 |
|
* other tasks. The default version of this method does nothing. |
| 105 |
|
* But it may be overridden in subclasses to perform some action |
| 106 |
|
* (for example a reduction) when this task is completes. |
| 112 |
|
|
| 113 |
|
/** |
| 114 |
|
* Overridable callback action triggered by |
| 115 |
< |
* <tt>completeExceptionally</tt>. Upon invocation, this task has |
| 115 |
> |
* {@code completeExceptionally}. Upon invocation, this task has |
| 116 |
|
* aborted due to an exception (accessible via |
| 117 |
< |
* <tt>getException</tt>). If this method returns <tt>true</tt>, |
| 117 |
> |
* {@code getException}). If this method returns {@code true}, |
| 118 |
|
* the exception propagates to the current task's |
| 119 |
|
* parent. Otherwise, normal completion is propagated. The |
| 120 |
|
* default version of this method does nothing and returns |
| 121 |
< |
* <tt>true</tt>. |
| 121 |
> |
* {@code true}. |
| 122 |
|
* @return true if this task's exception should be propagated to |
| 123 |
|
* this task's parent. |
| 124 |
|
*/ |
| 127 |
|
} |
| 128 |
|
|
| 129 |
|
/** |
| 130 |
< |
* Equivalent in effect to invoking <tt>linkSubtasks</tt> and then |
| 130 |
> |
* Equivalent in effect to invoking {@link #linkSubtasks} and then |
| 131 |
|
* forking both tasks. |
| 132 |
|
* @param x one subtask |
| 133 |
|
* @param y the other subtask |
| 156 |
|
|
| 157 |
|
/** |
| 158 |
|
* Completes this task, and if this task has a sibling that is |
| 159 |
< |
* also complete, invokes <tt>onComplete</tt> of parent task, and so |
| 159 |
> |
* also complete, invokes {@code onComplete} of parent task, and so |
| 160 |
|
* on. If an exception is encountered, tasks instead |
| 161 |
< |
* <tt>completeExceptionally</tt>. |
| 161 |
> |
* {@code completeExceptionally}. |
| 162 |
|
*/ |
| 163 |
|
public final void complete() { |
| 164 |
|
// todo: Use tryUnfork without possibly blowing stack |
| 184 |
|
/** |
| 185 |
|
* Completes this task abnormally. Unless this task already |
| 186 |
|
* cancelled or aborted, upon invocation, this method invokes |
| 187 |
< |
* <tt>onException</tt>, and then, depending on its return value, |
| 187 |
> |
* {@code onException}, and then, depending on its return value, |
| 188 |
|
* completees parent (if one exists) exceptionally or normally. To |
| 189 |
|
* avoid unbounded exception loops, this method aborts if an |
| 190 |
< |
* exception is encountered in any <tt>onException</tt> |
| 190 |
> |
* exception is encountered in any {@code onException} |
| 191 |
|
* invocation. |
| 192 |
|
* @param ex the exception to throw when joining this task |
| 193 |
|
* @throws NullPointerException if ex is null |
| 194 |
|
* @throws Throwable if any invocation of |
| 195 |
< |
* <tt>onException</tt> does so. |
| 195 |
> |
* {@code onException} does so. |
| 196 |
|
*/ |
| 197 |
|
public final void completeExceptionally(Throwable ex) { |
| 198 |
|
BinaryAsyncAction a = this; |
