ForkJoinWorkerThread - Android SDK

Added in API level 21

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 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.

[Expand]

Inherited Methods

From class java.lang.Thread

static int	activeCount() Returns the number of active `Thread`s in the running `Thread`'s group and its subgroups.
final void	checkAccess() Does nothing.
int	countStackFrames() This method was deprecated in API level 1. The results of this call were never well defined. To make things worse, it would depend on whether the Thread was suspended or not, and suspend was deprecated too.
static Thread	currentThread() Returns the Thread of the caller, that is, the current Thread.
void	destroy() This method was deprecated in API level 1. Not implemented.
static void	dumpStack() Prints to the standard error stream a text representation of the current stack for this Thread.
static int	enumerate(Thread[] threads) Copies an array with all Threads which are in the same ThreadGroup as the receiver - and subgroups - into the array `threads` passed as parameter.
static Map<Thread, StackTraceElement[]>	getAllStackTraces() Returns a map of all the currently live threads to their stack traces.
ClassLoader	getContextClassLoader() Returns the context ClassLoader for this Thread.
static Thread.UncaughtExceptionHandler	getDefaultUncaughtExceptionHandler() Returns the default exception handler that's executed when uncaught exception terminates a thread.
long	getId() Returns the thread's identifier.
final String	getName() Returns the name of the Thread.
final int	getPriority() Returns the priority of the Thread.
StackTraceElement[]	getStackTrace() Returns an array of `StackTraceElement` representing the current thread's stack.
Thread.State	getState() Returns the current state of the Thread.
final ThreadGroup	getThreadGroup() Returns the ThreadGroup to which this Thread belongs.
Thread.UncaughtExceptionHandler	getUncaughtExceptionHandler() Returns the thread's uncaught exception handler.
static boolean	holdsLock(Object object) Indicates whether the current Thread has a monitor lock on the specified object.
void	interrupt() Posts an interrupt request to this `Thread`.
static boolean	interrupted() Returns a `boolean` indicating whether the current Thread ( `currentThread()`) has a pending interrupt request (`true`) or not (`false`).
final boolean	isAlive() Returns `true` if the receiver has already been started and still runs code (hasn't died yet).
final boolean	isDaemon() Tests whether this is a daemon thread.
boolean	isInterrupted() Returns a `boolean` indicating whether the receiver has a pending interrupt request (`true`) or not ( `false`)
final void	join() Blocks the current Thread (`Thread.currentThread()`) until the receiver finishes its execution and dies.
final void	join(long millis, int nanos) Blocks the current Thread (`Thread.currentThread()`) until the receiver finishes its execution and dies or the specified timeout expires, whatever happens first.
final void	join(long millis) Blocks the current Thread (`Thread.currentThread()`) until the receiver finishes its execution and dies or the specified timeout expires, whatever happens first.
final void	resume() This method was deprecated in API level 1. Only useful in conjunction with deprecated method `suspend()`.
void	run() Calls the `run()` method of the Runnable object the receiver holds.
void	setContextClassLoader(ClassLoader cl) Set the context ClassLoader for the receiver.
final void	setDaemon(boolean isDaemon) Marks this thread as a daemon thread.
static void	setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler handler) Sets the default uncaught exception handler.
final void	setName(String threadName) Sets the name of the Thread.
final void	setPriority(int priority) Sets the priority of this thread.
void	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler handler) Sets the uncaught exception handler.
static void	sleep(long millis, int nanos) Causes the thread which sent this message to sleep for the given interval of time (given in milliseconds and nanoseconds).
static void	sleep(long time) Causes the thread which sent this message to sleep for the given interval of time (given in milliseconds).
synchronized void	start() Starts the new Thread of execution.
synchronized final void	stop(Throwable throwable) This method was deprecated in API level 1. because stopping a thread in this manner is unsafe and can leave your application and the VM in an unpredictable state.
final void	stop() This method was deprecated in API level 1. because stopping a thread in this manner is unsafe and can leave your application and the VM in an unpredictable state.
final void	suspend() This method was deprecated in API level 1. May cause deadlocks.
String	toString() Returns a string containing a concise, human-readable description of the Thread.
static void	yield() Causes the calling Thread to yield execution time to another Thread that is ready to run.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	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() 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	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, 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(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.lang.Runnable

Protected Constructors

protected ForkJoinWorkerThread (ForkJoinPool pool)

Added in API level 21

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 ()

Added in API level 21

Returns the pool hosting this thread.

Returns

the pool

public int getPoolIndex ()

Added in API level 21

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 ()

Added in API level 21

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 ()

Added in API level 21

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)

Added in API level 21

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

Results

Interfaces

Classes

Enums

Exceptions

ForkJoinWorkerThread

Class Overview

Summary

Protected Constructors

protected ForkJoinWorkerThread (ForkJoinPool pool)

Parameters

Throws

Public Methods

public ForkJoinPool getPool ()

Returns

public int getPoolIndex ()

Returns

public void run ()

Protected Methods

protected void onStart ()

protected void onTermination (Throwable exception)

Parameters