ForkJoinTask

ForkJoinTask

ForkJoinTask ()

adapt

ForkJoinTask<T> adapt (Runnable runnable, 
                T result)

返回一个新的 ForkJoinTask ，该 run执行给定 Runnable的 run方法作为其操作，并将给定结果返回到 join() 。

adapt

ForkJoinTask<?> adapt (Runnable runnable)

返回一个新的 ForkJoinTask ，它执行给定 Runnable的 run方法作为其操作，并在 join()返回空结果。

adapt

ForkJoinTask<T> adapt (Callable<? extends T> callable)

返回一个新的 ForkJoinTask ，该 call执行给定 Callable的 call方法作为其操作，并在 join()返回结果，将遇到的任何检查的异常转换为 RuntimeException 。

cancel

boolean cancel (boolean mayInterruptIfRunning)

试图取消执行此任务。 如果任务已完成或由于其他原因无法取消，则此尝试将失败。 如果成功，并且调用cancel时此任务尚未开始，则此任务的执行将被取消。 经过此方法成功返回，除非有介入呼叫reinitialize() ，后续调用isCancelled() ， isDone() ，并cancel将返回true ，并呼吁join() ，并会导致相关方法CancellationException 。

这个方法可以在子类中被覆盖，但如果是这样的话，仍然必须确保这些属性保持不变。 特别是， cancel方法本身不能抛出异常。

此方法旨在由其他任务调用。 要终止当前任务，只需从计算方法中返回或抛出一个未检查的异常，或者调用completeExceptionally(Throwable) 。

compareAndSetForkJoinTaskTag

boolean compareAndSetForkJoinTaskTag (short expect, 
                short update)

原子上有条件地设置此任务的标记值。 在其他应用程序中，标记可用作图形操作任务中的访问标记，如在处理之前检查： if (task.compareAndSetForkJoinTaskTag((short)0, (short)1))方法，否则由于节点已被访问而退出。

complete

void complete (V value)

完成此任务，如果尚未中止或取消，则返回给定值，作为后续调用join和相关操作的结果。 此方法可用于为异步任务提供结果，或为通常无法完成的任务提供备选处理。 不鼓励在其他情况下使用它。 此方法是可覆盖的，但重写的版本必须调用super实现来维护保证。

completeExceptionally

void completeExceptionally (Throwable ex)

异常完成此任务，如果尚未中止或取消，则导致它在join和相关操作中抛出给定异常。 此方法可用于诱发异步任务中的异常，或强制完成不会完成的任务。 不鼓励在其他情况下使用它。 此方法是可覆盖的，但被覆盖的版本必须调用super实现来维护保证。

fork

ForkJoinTask<V> fork ()

安排在池异步执行这一任务，当前任务运行在（如果适用），或使用commonPool()如果不是inForkJoinPool() 。 虽然它不一定是强制执行的，但除非已完成并重新初始化，否则多次分叉任务是一种使用错误。 对任务状态或其操作的任何数据的后续修改不一定可以由除执行它之外的任何线程始终观察到，除非在调用join()或相关方法之前，或者调用isDone()返回true 。

get

V get (long timeout, 
                TimeUnit unit)

如果需要，最多等待计算完成的给定时间，然后检索其结果（如果可用）。

get

V get ()

如果需要，等待计算完成，然后检索其结果。

getException

Throwable getException ()

返回由基本计算抛出的异常，或者 CancellationException如果取消），或者 null如果没有）或方法尚未完成。

getForkJoinTaskTag

short getForkJoinTaskTag ()

返回此任务的标签。

getPool

ForkJoinPool getPool ()

如果当前线程在任何ForkJoinPool外部执行，则返回承载当前线程的池或 null 。

该方法返回 null当且仅当 inForkJoinPool()回报 false 。

getQueuedTaskCount

int getQueuedTaskCount ()

返回当前工作线程已分叉但尚未执行的任务数的估计值。 这个值对于是否要分叉其他任务的启发式决策可能很有用。

getRawResult

V getRawResult ()

返回join()返回的结果，即使此任务异常完成，或者null如果此任务未知完成）。 此方法旨在帮助调试以及支持扩展。 不鼓励在任何其他情况下使用它。

getSurplusQueuedTaskCount

int getSurplusQueuedTaskCount ()

返回当前工作线程持有多少本地排队任务的估计值，而不是其他可能窃取它们的工作线程的值，如果此线程未在ForkJoinPool中运行，则返回零。 这个值对于是否要分叉其他任务的启发式决策可能很有用。 在ForkJoinTasks的许多用法中，在稳定状态下，每个工作人员应该致力于保持一个小的恒定剩余（例如3个）任务，并在超出此阈值时在本地处理计算。

helpQuiesce

void helpQuiesce ()

可能会执行任务，直到承载当前任务的池is quiescent 。 这种方法可能用于许多任务分叉的设计中，但没有一个是明确加入的，而是执行它们直到处理完所有任务。

inForkJoinPool

boolean inForkJoinPool ()

返回 true如果当前线程是 ForkJoinWorkerThread执行作为ForkJoinPool计算。

invoke

V invoke ()

开始执行此任务，如果需要等待完成，并返回其结果，或者如果底层计算执行此操作，则抛出（未选中） RuntimeException或 Error 。

invokeAll

void invokeAll (ForkJoinTask...<?> tasks)

isDone给定的任务，当isDone对每个任务保持isDone或遇到（未检查）的异常时返回，在这种情况下重新排除异常。 如果多个任务遇到异常，则此方法将引发这些异常中的任何一个。 如果任何任务遇到异常，其他人可能会被取消。 但是，个别任务的执行状态在异常返回时无法得到保证。 每个任务的状态可以使用getException()和相关方法来获得，以检查它们是否已被取消，正常或异常完成，还是未处理。

invokeAll

void invokeAll (ForkJoinTask<?> t1, 
                ForkJoinTask<?> t2)

isDone给定的任务，当isDone保持每个任务或遇到（未检查）的异常时返回，在这种情况下，异常被重新抛出。 如果多个任务遇到异常，则此方法将引发这些异常中的任何一个。 如果任何任务遇到异常，则可能会取消另一个任务。 但是，个别任务的执行状态在异常返回时无法得到保证。 每个任务的状态可以使用getException()和相关方法来获得，以检查它们是否已被取消，正常或异常完成，还是未处理。

invokeAll

Collection<T> invokeAll (Collection<T> tasks)

isDone指定集合中的所有任务，当每个任务保持isDone或遇到（未检查）异常时返回，在这种情况下，将重新抛出异常。 如果多个任务遇到异常，则此方法将引发这些异常中的任何一个。 如果任何任务遇到异常，其他人可能会被取消。 但是，个别任务的执行状态在异常返回时无法得到保证。 每个任务的状态可以使用getException()和相关方法来获得，以检查它们是否被取消，正常或异常完成，还是未处理。

isCancelled

boolean isCancelled ()

如果此任务在正常完成之前取消，则返回 true 。

isCompletedAbnormally

boolean isCompletedAbnormally ()

如果此任务引发异常或被取消，则返回 true 。

isCompletedNormally

boolean isCompletedNormally ()

如果此任务完成而没有抛出异常并且未取消，则返回 true 。

isDone

boolean isDone ()

如果此任务完成，则返回true 。 完成可能是由于正常终止，例外或取消 - 在所有这些情况下，此方法将返回true 。

join

V join ()

返回is done时的计算结果。 此方法不同于get()的异常完成结果为RuntimeException或Error而不是ExecutionException ，并且调用线程的中断不会导致方法通过抛出InterruptedException突然返回。

quietlyComplete

void quietlyComplete ()

通常无需设置值即可完成此任务。 setRawResult(V) （或默认为null ）确定的最新值将作为后续调用join和相关操作的结果返回。

quietlyInvoke

void quietlyInvoke ()

开始执行此任务并在必要时等待完成，而不返回结果或抛出异常。

quietlyJoin

void quietlyJoin ()

加入此任务，但不返回结果或抛出异常。 在处理某些已被取消或已知中止的任务时，此方法可能很有用。

reinitialize

void reinitialize ()

重置此任务的内部簿记状态，允许随后的fork 。 此方法允许重复使用此任务，但只有当此任务从未分叉，或分叉，然后完成并且此任务的所有未完成连接也已完成时才发生重用。 无法保证其他任何使用条件下的效果。 在循环中执行子任务的预构建树时，此方法可能很有用。

完成此方法后， isDone()报告false和getException()报告null 。 但是， getRawResult返回的值不受影响。 要清除此值，可以调用setRawResult(null) 。

setForkJoinTaskTag

short setForkJoinTaskTag (short newValue)

以原子方式设置此任务的标记值并返回旧值。

tryUnfork

boolean tryUnfork ()

试图排除这个任务的执行。 如果此任务是当前线程的最近派生任务，并且尚未开始在另一个线程中执行，则此方法通常（但不能保证）成功。 这种方法在安排替代本地处理可能已经被盗但未被盗的任务时可能很有用。

exec

boolean exec ()

立即执行此任务的基本操作，并返回true，如果从此方法返回后，此任务保证已正常完成。 否则，此方法可能会返回false，以指示此任务不一定完成（或未知完成），例如在需要显式调用完成方法的异步操作中。 此方法也可能会引发（未检查）异常以指示异常退出。 此方法旨在支持扩展，通常不应另行调用。

peekNextLocalTask

ForkJoinTask<?> peekNextLocalTask ()

返回但不排除或执行由当前线程排队但尚未执行的任务（如果立即可用）。 无法保证此任务将被实际轮询或接下来执行。 相反，即使存在任务，该方法也可以返回空值，但如果没有与其他线程竞争则无法访问该方法。 此方法主要是为了支持扩展而设计的，否则不太可能有用。

pollNextLocalTask

ForkJoinTask<?> pollNextLocalTask ()

如果当前线程正在ForkJoinPool中运行，那么取消调度并返回（不执行）下一个由当前线程排队但尚未执行的任务。 此方法主要是为了支持扩展而设计的，否则不太可能有用。

pollTask

ForkJoinTask<?> pollTask ()

如果当前线程正在ForkJoinPool中运行，则取消调度并返回（不执行）由当前线程排队但尚未执行的下一个任务（如果有）或者不可用时由其他线程分叉的任务，如果可供使用的话。 可用性可能是暂时的，因此null结果并不一定意味着此任务运行的池的静止。此方法主要是为了支持扩展而设计的，否则不太有用。

setRawResult

void setRawResult (V value)

因此强制返回给定的值。 此方法旨在支持扩展，通常不应另行调用。