ForkJoinWorkerThread - JRE Emulation | JRE Emulation
public class

ForkJoinWorkerThread

extends Thread
java.lang.Object
   ↳ java.lang.Thread
     ↳ java.util.concurrent.ForkJoinWorkerThread

Class Overview

A thread managed by a ForkJoinPool, which executes ForkJoinTasks. This class is subclassable solely for the sake of adding functionality -- there are no overridable methods dealing with scheduling or execution. However, you can override initialization and termination methods surrounding the main task processing loop. If you do create such a subclass, you will also need to supply a custom ForkJoinPool.ForkJoinWorkerThreadFactory to {@linkplain ForkJoinPool#ForkJoinPool use it} in a ForkJoinPool.

Summary

[Expand]
Inherited Constants
From class java.lang.Thread
Protected Constructors
ForkJoinWorkerThread(ForkJoinPool pool)
Creates a ForkJoinWorkerThread operating in the given pool.
Public Methods
ForkJoinPool getPool()
Returns the pool hosting this thread.
int getPoolIndex()
Returns the unique index number of this thread in its pool.
void run()
This method is required to be public, but should never be called explicitly.
Protected Methods
void onStart()
Initializes internal state after construction but before processing any tasks.
void onTermination(Throwable exception)
Performs cleanup associated with termination of this worker thread.
Inherited Methods
[Expand]
From class java.lang.Thread
From class java.lang.Object
From interface java.lang.Runnable

Protected Constructors

protected ForkJoinWorkerThread (ForkJoinPool pool)

Creates a ForkJoinWorkerThread operating in the given pool.

Parameters
pool the pool this thread works in
Throws
NullPointerException if pool is null

Public Methods

public ForkJoinPool getPool ()

Returns the pool hosting this thread.

Returns
  • the pool

public int getPoolIndex ()

Returns the unique index number of this thread in its pool. The returned value ranges from zero to the maximum number of threads (minus one) that may exist in the pool, and does not change during the lifetime of the thread. This method may be useful for applications that track status or collect results per-worker-thread rather than per-task.

Returns
  • the index number

public void run ()

This method is required to be public, but should never be called explicitly. It performs the main run loop to execute ForkJoinTasks.

Protected Methods

protected void onStart ()

Initializes internal state after construction but before processing any tasks. If you override this method, you must invoke super.onStart() at the beginning of the method. Initialization requires care: Most fields must have legal default values, to ensure that attempted accesses from other threads work correctly even before this thread starts processing tasks.

protected void onTermination (Throwable exception)

Performs cleanup associated with termination of this worker thread. If you override this method, you must invoke super.onTermination at the end of the overridden method.

Parameters
exception the exception causing this thread to abort due to an unrecoverable error, or null if completed normally