# RecursiveAction

public abstract class **RecursiveAction** extends [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<[Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html)\>  
A recursive resultless `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html`. This class
establishes conventions to parameterize resultless actions as
`Void` `ForkJoinTask`s. Because `null` is the
only valid value of type `Void`, methods such as `join`
always return `null` upon completion.

**Sample Usages.** Here is a simple but complete ForkJoin
sort that sorts a given `long[]` array:

     static class SortTask extends RecursiveAction {
       final long[] array; final int lo, hi;
       SortTask(long[] array, int lo, int hi) {
         this.array = array; this.lo = lo; this.hi = hi;
       }
       SortTask(long[] array) { this(array, 0, array.length); }
       protected void compute() {
         if (hi - lo < THRESHOLD)
           sortSequentially(lo, hi);
         else {
           int mid = (lo + hi) >>> 1;
           invokeAll(new SortTask(array, lo, mid),
                     new SortTask(array, mid, hi));
           merge(lo, mid, hi);
         }
       }
       // implementation details follow:
       static final int THRESHOLD = 1000;
       void sortSequentially(int lo, int hi) {
         Arrays.sort(array, lo, hi);
       }
       void merge(int lo, int mid, int hi) {
         long[] buf = Arrays.copyOfRange(array, lo, mid);
         for (int i = 0, j = lo, k = mid; i < buf.length; j++)
           array[j] = (k == hi || buf[i] < array[k]) ?
             buf[i++] : array[k++];
       }
     }

You could then sort `anArray` by creating `new
SortTask(anArray)` and invoking it in a ForkJoinPool. As a more concrete simple example, the following task increments each element of an array:

     class IncrementTask extends RecursiveAction {
       final long[] array; final int lo, hi;
       IncrementTask(long[] array, int lo, int hi) {
         this.array = array; this.lo = lo; this.hi = hi;
       }
       protected void compute() {
         if (hi - lo < THRESHOLD) {
           for (int i = lo; i < hi; ++i)
             array[i]++;
         }
         else {
           int mid = (lo + hi) >>> 1;
           invokeAll(new IncrementTask(array, lo, mid),
                     new IncrementTask(array, mid, hi));
         }
       }
     }

The following example illustrates some refinements and idioms
that may lead to better performance: RecursiveActions need not be
fully recursive, so long as they maintain the basic
divide-and-conquer approach. Here is a class that sums the squares
of each element of a double array, by subdividing out only the
right-hand-sides of repeated divisions by two, and keeping track of
them with a chain of `next` references. It uses a dynamic
threshold based on method `getSurplusQueuedTaskCount`, but
counterbalances potential excess partitioning by directly
performing leaf actions on unstolen tasks rather than further
subdividing.

     double sumOfSquares(ForkJoinPool pool, double[] array) {
       int n = array.length;
       Applyer a = new Applyer(array, 0, n, null);
       pool.invoke(a);
       return a.result;
     }

     class Applyer extends RecursiveAction {
       final double[] array;
       final int lo, hi;
       double result;
       Applyer next; // keeps track of right-hand-side tasks
       Applyer(double[] array, int lo, int hi, Applyer next) {
         this.array = array; this.lo = lo; this.hi = hi;
         this.next = next;
       }

       double atLeaf(int l, int h) {
         double sum = 0;
         for (int i = l; i < h; ++i) // perform leftmost base step
           sum += array[i] * array[i];
         return sum;
       }

       protected void compute() {
         int l = lo;
         int h = hi;
         Applyer right = null;
         while (h - l > 1 && getSurplusQueuedTaskCount() <= 3) {
           int mid = (l + h) >>> 1;
           right = new Applyer(array, mid, h, right);
           right.fork();
           h = mid;
         }
         double sum = atLeaf(l, h);
         while (right != null) {
           if (right.tryUnfork()) // directly calculate if not stolen
             sum += right.atLeaf(right.lo, right.hi);
           else {
             right.join();
             sum += right.result;
           }
           right = right.next;
         }
         result = sum;
       }
     }

<br />

### Public Constructor Summary

|---|---|
|   | [RecursiveAction](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RecursiveAction.html#RecursiveAction())() |

### Public Method Summary

|---|---|
| final [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [getRawResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RecursiveAction.html#getRawResult())() Always returns `null`. |

### Protected Method Summary

|---|---|
| abstract void | [compute](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RecursiveAction.html#compute())() The main computation performed by this task. |
| final boolean | [exec](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RecursiveAction.html#exec())() Implements execution conventions for RecursiveActions. |
| final void | [setRawResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/RecursiveAction.html#setRawResult(java.lang.Void))([Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) mustBeNull) Requires null completion value. |

### Inherited Method Summary

From class [java.util.concurrent.ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)

|---|---|
| static \<T\> [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<T\> | [adapt](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#adapt(java.lang.Runnable,%20T))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) runnable, T result) Returns a new `ForkJoinTask` that performs the `run` method of the given `Runnable` as its action, and returns the given result upon `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#join()`. |
| static [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> | [adapt](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#adapt(java.lang.Runnable))([Runnable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Runnable.html) runnable) Returns a new `ForkJoinTask` that performs the `run` method of the given `Runnable` as its action, and returns a null result upon `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#join()`. |
| static \<T\> [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<T\> | [adapt](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#adapt(java.util.concurrent.Callable<?%20extends%20T>))([Callable](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Callable.html)\<? extends T\> callable) Returns a new `ForkJoinTask` that performs the `call` method of the given `Callable` as its action, and returns its result upon `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#join()`, translating any checked exceptions encountered into `RuntimeException`. |
| boolean | [cancel](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#cancel(boolean))(boolean mayInterruptIfRunning) Attempts to cancel execution of this task. |
| final boolean | [compareAndSetForkJoinTaskTag](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#compareAndSetForkJoinTaskTag(short,%20short))(short expect, short update) Atomically conditionally sets the tag value for this task. |
| void | [complete](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#complete(V))([Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) value) Completes this task, and if not already aborted or cancelled, returning the given value as the result of subsequent invocations of `join` and related operations. |
| void | [completeExceptionally](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#completeExceptionally(java.lang.Throwable))([Throwable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Throwable.html) ex) Completes this task abnormally, and if not already aborted or cancelled, causes it to throw the given exception upon `join` and related operations. |
| abstract boolean | [exec](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#exec())() Immediately performs the base action of this task and returns true if, upon return from this method, this task is guaranteed to have completed normally. |
| final [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<[Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html)\> | [fork](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#fork())() Arranges to asynchronously execute this task in the pool the current task is running in, if applicable, or using the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinPool.html#commonPool()` if not `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#inForkJoinPool()`. |
| final [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#get(long,%20java.util.concurrent.TimeUnit))(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. |
| final [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#get())() Waits if necessary for the computation to complete, and then retrieves its result. |
| final [Throwable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Throwable.html) | [getException](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#getException())() Returns the exception thrown by the base computation, or a `CancellationException` if cancelled, or `null` if none or if the method has not yet completed. |
| final short | [getForkJoinTaskTag](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#getForkJoinTaskTag())() Returns the tag for this task. |
| static [ForkJoinPool](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinPool.html) | [getPool](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#getPool())() Returns the pool hosting the current thread, or `null` if the current thread is executing outside of any ForkJoinPool. |
| static int | [getQueuedTaskCount](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#getQueuedTaskCount())() Returns an estimate of the number of tasks that have been forked by the current worker thread but not yet executed. |
| abstract [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [getRawResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#getRawResult())() Returns the result that would be returned by `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#join()`, even if this task completed abnormally, or `null` if this task is not known to have been completed. |
| static int | [getSurplusQueuedTaskCount](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#getSurplusQueuedTaskCount())() Returns an estimate of how many more locally queued tasks are held by the current worker thread than there are other worker threads that might steal them, or zero if this thread is not operating in a ForkJoinPool. |
| static void | [helpQuiesce](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#helpQuiesce())() Possibly executes tasks until the pool hosting the current task {@linkplain ForkJoinPool#isQuiescent is quiescent}. |
| static boolean | [inForkJoinPool](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#inForkJoinPool())() Returns `true` if the current thread is a `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinWorkerThread.html` executing as a ForkJoinPool computation. |
| final [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [invoke](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#invoke())() Commences performing this task, awaits its completion if necessary, and returns its result, or throws an (unchecked) `RuntimeException` or `Error` if the underlying computation did so. |
| static void | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#invokeAll(java.util.concurrent.ForkJoinTask<?>...))([ForkJoinTask...](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> tasks) Forks the given tasks, returning when `isDone` holds for each task or an (unchecked) exception is encountered, in which case the exception is rethrown. |
| static void | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#invokeAll(java.util.concurrent.ForkJoinTask<?>,%20java.util.concurrent.ForkJoinTask<?>))([ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> t1, [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> t2) Forks the given tasks, returning when `isDone` holds for each task or an (unchecked) exception is encountered, in which case the exception is rethrown. |
| static \<T extends [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\>\> [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<T\> | [invokeAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#invokeAll(java.util.Collection<T>))([Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<T\> tasks) Forks all tasks in the specified collection, returning when `isDone` holds for each task or an (unchecked) exception is encountered, in which case the exception is rethrown. |
| final boolean | [isCancelled](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#isCancelled())() Returns `true` if this task was cancelled before it completed normally. |
| final boolean | [isCompletedAbnormally](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#isCompletedAbnormally())() Returns `true` if this task threw an exception or was cancelled. |
| final boolean | [isCompletedNormally](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#isCompletedNormally())() Returns `true` if this task completed without throwing an exception and was not cancelled. |
| final boolean | [isDone](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#isDone())() Returns `true` if this task completed. |
| final [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [join](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#join())() Returns the result of the computation when it `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#isDone()`. |
| static [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> | [peekNextLocalTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#peekNextLocalTask())() Returns, but does not unschedule or execute, a task queued by the current thread but not yet executed, if one is immediately available. |
| static [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> | [pollNextLocalTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#pollNextLocalTask())() Unschedules and returns, without executing, the next task queued by the current thread but not yet executed, if the current thread is operating in a ForkJoinPool. |
| static [ForkJoinTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html)\<?\> | [pollTask](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#pollTask())() If the current thread is operating in a ForkJoinPool, unschedules and returns, without executing, the next task queued by the current thread but not yet executed, if one is available, or if not available, a task that was forked by some other thread, if available. |
| final void | [quietlyComplete](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#quietlyComplete())() Completes this task normally without setting a value. |
| final void | [quietlyInvoke](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#quietlyInvoke())() Commences performing this task and awaits its completion if necessary, without returning its result or throwing its exception. |
| final void | [quietlyJoin](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#quietlyJoin())() Joins this task, without returning its result or throwing its exception. |
| void | [reinitialize](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#reinitialize())() Resets the internal bookkeeping state of this task, allowing a subsequent `fork`. |
| final short | [setForkJoinTaskTag](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#setForkJoinTaskTag(short))(short newValue) Atomically sets the tag value for this task and returns the old value. |
| abstract void | [setRawResult](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#setRawResult(V))([Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) value) Forces the given value to be returned as a result. |
| boolean | [tryUnfork](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ForkJoinTask.html#tryUnfork())() Tries to unschedule this task for execution. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.util.concurrent.Future](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html)

|---|---|
| abstract boolean | [cancel](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html#cancel(boolean))(boolean mayInterruptIfRunning) Attempts to cancel execution of this task. |
| abstract [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html#get(long,%20java.util.concurrent.TimeUnit))(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. |
| abstract [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html#get())() Waits if necessary for the computation to complete, and then retrieves its result. |
| abstract boolean | [isCancelled](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html#isCancelled())() Returns `true` if this task was cancelled before it completed normally. |
| abstract boolean | [isDone](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Future.html#isDone())() Returns `true` if this task completed. |

## Public Constructors

#### public
**RecursiveAction**
()

<br />

## Public Methods

#### public final [Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html)
**getRawResult**
()

Always returns `null`.

##### Returns

- `null` always

## Protected Methods

#### protected abstract void
**compute**
()

The main computation performed by this task.

#### protected final boolean
**exec**
()

Implements execution conventions for RecursiveActions.

##### Returns

- `true` if this task is known to have completed normally

#### protected final void
**setRawResult**
([Void](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Void.html) mustBeNull)

Requires null completion value.

##### Parameters

| mustBeNull | the value |
|---|---|