Added in API level 21

ForkJoinWorkerThread

open class ForkJoinWorkerThread : Thread

kotlin.Any
↳	java.lang.Thread
	↳	java.util.concurrent.ForkJoinWorkerThread

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 java.util.concurrent.ForkJoinPool#ForkJoinPool(int,ForkJoinWorkerThreadFactory,java.lang.Thread.UncaughtExceptionHandler,boolean,int,int,int,Predicate,long,java.util.concurrent.TimeUnit) in a ForkJoinPool.

Summary

Inherited constants

From class Thread

Int

MAX_PRIORITY

The maximum priority that a thread can have.

Int

MIN_PRIORITY

The minimum priority that a thread can have.

Int

NORM_PRIORITY

The default priority that is assigned to a thread.

Protected constructors
`ForkJoinWorkerThread(group: ThreadGroup!, pool: ForkJoinPool!, preserveThreadLocals: Boolean)` Creates a ForkJoinWorkerThread operating in the given thread group and pool, and with the given policy for preserving ThreadLocals.
`ForkJoinWorkerThread(pool: ForkJoinPool!)` Creates a ForkJoinWorkerThread operating in the given pool.

Public methods
open ForkJoinPool!	`getPool()` Returns the pool hosting this thread.
open Int	`getPoolIndex()` Returns the unique index number of this thread in its pool.
open Int	`getQueuedTaskCount()` {@return a (non-negative) estimate of the number of tasks in the * thread's queue}
open Unit	`run()` This method is required to be public, but should never be called explicitly.

Protected methods
open Unit	`onStart()` Initializes internal state after construction but before processing any tasks.
open Unit	`onTermination(exception: Throwable!)` Performs cleanup associated with termination of this worker thread.

Inherited functions

From class Thread

`Int`	`activeCount()` Returns an estimate of the number of active threads in the current thread's thread group and its subgroups. Recursively iterates over all subgroups in the current thread's thread group. The value returned is only an estimate because the number of threads may change dynamically while this method traverses internal data structures, and might be affected by the presence of certain system threads. This method is intended primarily for debugging and monitoring purposes.
`Unit`	`checkAccess()` Determines if the currently running thread has permission to modify this thread. If there is a security manager, its `checkAccess` method is called with this thread as its argument. This may result in throwing a `SecurityException`.
`Any`	`clone()` Throws CloneNotSupportedException as a Thread can not be meaningfully cloned. Construct a new Thread instead.
`Int`	`countStackFrames()` Counts the number of stack frames in this thread. The thread must be suspended.
`Thread`	`currentThread()` Returns a reference to the currently executing thread object.
`Unit`	`destroy()` Throws `UnsupportedOperationException`.
`Unit`	`dumpStack()` Prints a stack trace of the current thread to the standard error stream. This method is used only for debugging.
`Int`	`enumerate(tarray: Array<Thread!>!)` Copies into the specified array every active thread in the current thread's thread group and its subgroups. This method simply invokes the `java.lang.ThreadGroup#enumerate(Thread[])` method of the current thread's thread group. An application might use the activeCount method to get an estimate of how big the array should be, however if the array is too short to hold all the threads, the extra threads are silently ignored. If it is critical to obtain every active thread in the current thread's thread group and its subgroups, the invoker should verify that the returned int value is strictly less than the length of `tarray`. Due to the inherent race condition in this method, it is recommended that the method only be used for debugging and monitoring purposes.
`MutableMap<Thread!, Array<StackTraceElement!>!>`	`getAllStackTraces()` Returns a map of stack traces for all live threads. The map keys are threads and each map value is an array of `StackTraceElement` that represents the stack dump of the corresponding `Thread`. The returned stack traces are in the format specified for the `getStackTrace` method. The threads may be executing while this method is called. The stack trace of each thread only represents a snapshot and each stack trace may be obtained at different time. A zero-length array will be returned in the map value if the virtual machine has no stack trace information about a thread.
`ClassLoader?`	`getContextClassLoader()` Returns the context `ClassLoader` for this thread. The context `ClassLoader` is provided by the creator of the thread for use by code running in this thread when loading classes and resources. If not set, the default is the `ClassLoader` context of the parent thread. The context `ClassLoader` of the primordial thread is typically set to the class loader used to load the application.
`Thread.UncaughtExceptionHandler?`	`getDefaultUncaughtExceptionHandler()` Returns the default handler invoked when a thread abruptly terminates due to an uncaught exception. If the returned value is `null`, there is no default.
`Long`	`getId()` Returns the identifier of this Thread. The thread ID is a positive `long` number generated when this thread was created. The thread ID is unique and remains unchanged during its lifetime. When a thread is terminated, this thread ID may be reused.
`String`	`getName()` Returns this thread's name.
`Int`	`getPriority()` Returns this thread's priority.
`Array<StackTraceElement!>`	`getStackTrace()` Returns an array of stack trace elements representing the stack dump of this thread. This method will return a zero-length array if this thread has not started, has started but has not yet been scheduled to run by the system, or has terminated. If the returned array is of non-zero length then the first element of the array represents the top of the stack, which is the most recent method invocation in the sequence. The last element of the array represents the bottom of the stack, which is the least recent method invocation in the sequence. If there is a security manager, and this thread is not the current thread, then the security manager's `checkPermission` method is called with a `RuntimePermission("getStackTrace")` permission to see if it's ok to get the stack trace. Some virtual machines may, under some circumstances, omit one or more stack frames from the stack trace. In the extreme case, a virtual machine that has no stack trace information concerning this thread is permitted to return a zero-length array from this method.
`Thread.State`	`getState()` Returns the state of this thread. This method is designed for use in monitoring of the system state, not for synchronization control.
`ThreadGroup?`	`getThreadGroup()` Returns the thread group to which this thread belongs. This method returns null if this thread has died (been stopped).
`Thread.UncaughtExceptionHandler?`	`getUncaughtExceptionHandler()` Returns the handler invoked when this thread abruptly terminates due to an uncaught exception. If this thread has not had an uncaught exception handler explicitly set then this thread's `ThreadGroup` object is returned, unless this thread has terminated, in which case `null` is returned.
`Boolean`	`holdsLock(obj: Any)` Returns `true` if and only if the current thread holds the monitor lock on the specified object. This method is designed to allow a program to assert that the current thread already holds a specified lock: assert Thread.holdsLock(obj);
`Unit`	`interrupt()` Interrupts this thread. Unless the current thread is interrupting itself, which is always permitted, the `checkAccess` method of this thread is invoked, which may cause a `SecurityException` to be thrown. If this thread is blocked in an invocation of the `wait()`, `wait(long)`, or `wait(long, int)` methods of the `Object` class, or of the `join()`, `join(long)`, `join(long,int)`, `sleep(long)`, or `sleep(long,int)`, methods of this class, then its interrupt status will be cleared and it will receive an `InterruptedException`. If this thread is blocked in an I/O operation upon an then the channel will be closed, the thread's interrupt status will be set, and the thread will receive a . If this thread is blocked in a `java.nio.channels.Selector` then the thread's interrupt status will be set and it will return immediately from the selection operation, possibly with a non-zero value, just as if the selector's `wakeup` method were invoked. If none of the previous conditions hold then this thread's interrupt status will be set. Interrupting a thread that is not alive need not have any effect.
`Boolean`	`interrupted()` Tests whether the current thread has been interrupted. The interrupted status of the thread is cleared by this method. In other words, if this method were to be called twice in succession, the second call would return false (unless the current thread were interrupted again, after the first call had cleared its interrupted status and before the second call had examined it). A thread interruption ignored because a thread was not alive at the time of the interrupt will be reflected by this method returning false.
`Boolean`	`isAlive()` Tests if this thread is alive. A thread is alive if it has been started and has not yet died.
`Boolean`	`isDaemon()` Tests if this thread is a daemon thread.
`Boolean`	`isInterrupted()` Tests whether this thread has been interrupted. The interrupted status of the thread is unaffected by this method. A thread interruption ignored because a thread was not alive at the time of the interrupt will be reflected by this method returning false.
`Unit`	`join()` Waits for this thread to die. An invocation of this method behaves in exactly the same way as the invocation join`(0)`
`Unit`	`join(millis: Long)` Waits at most `millis` milliseconds for this thread to die. A timeout of `0` means to wait forever. This implementation uses a loop of `this.wait` calls conditioned on `this.isAlive`. As a thread terminates the `this.notifyAll` method is invoked. It is recommended that applications not use `wait`, `notify`, or `notifyAll` on `Thread` instances.
`Unit`	`join(millis: Long, nanos: Int)` Waits at most `millis` milliseconds plus `nanos` nanoseconds for this thread to die. If both arguments are `0`, it means to wait forever. This implementation uses a loop of `this.wait` calls conditioned on `this.isAlive`. As a thread terminates the `this.notifyAll` method is invoked. It is recommended that applications not use `wait`, `notify`, or `notifyAll` on `Thread` instances.
`Unit`	`onSpinWait()` Indicates that the caller is momentarily unable to progress, until the occurrence of one or more actions on the part of other activities. By invoking this method within each iteration of a spin-wait loop construct, the calling thread indicates to the runtime that it is busy-waiting. The runtime may take action to improve the performance of invoking spin-wait loop constructions.
`Unit`	`resume()` Throws `UnsupportedOperationException`.
`Unit`	`setContextClassLoader(cl: ClassLoader?)` Sets the context ClassLoader for this Thread. The context ClassLoader can be set when a thread is created, and allows the creator of the thread to provide the appropriate class loader, through `getContextClassLoader`, to code running in the thread when loading classes and resources. If a security manager is present, its `checkPermission` method is invoked with a `RuntimePermission("setContextClassLoader")` permission to see if setting the context ClassLoader is permitted.
`Unit`	`setDaemon(on: Boolean)` Marks this thread as either a daemon thread or a user thread. The Java Virtual Machine exits when the only threads running are all daemon threads. This method must be invoked before the thread is started.
`Unit`	`setDefaultUncaughtExceptionHandler(eh: Thread.UncaughtExceptionHandler?)` Set the default handler invoked when a thread abruptly terminates due to an uncaught exception, and no other handler has been defined for that thread. Uncaught exception handling is controlled first by the thread, then by the thread's `ThreadGroup` object and finally by the default uncaught exception handler. If the thread does not have an explicit uncaught exception handler set, and the thread's thread group (including parent thread groups) does not specialize its `uncaughtException` method, then the default handler's `uncaughtException` method will be invoked. By setting the default uncaught exception handler, an application can change the way in which uncaught exceptions are handled (such as logging to a specific device, or file) for those threads that would already accept whatever "default" behavior the system provided. Note that the default uncaught exception handler should not usually defer to the thread's `ThreadGroup` object, as that could cause infinite recursion.
`Unit`	`setName(name: String)` Changes the name of this thread to be equal to the argument `name`. First the `checkAccess` method of this thread is called with no arguments. This may result in throwing a `SecurityException`.
`Unit`	`setPriority(newPriority: Int)` Changes the priority of this thread. First the `checkAccess` method of this thread is called with no arguments. This may result in throwing a `SecurityException`. Otherwise, the priority of this thread is set to the smaller of the specified `newPriority` and the maximum permitted priority of the thread's thread group.
`Unit`	`setUncaughtExceptionHandler(eh: Thread.UncaughtExceptionHandler?)` Set the handler invoked when this thread abruptly terminates due to an uncaught exception. A thread can take full control of how it responds to uncaught exceptions by having its uncaught exception handler explicitly set. If no such handler is set then the thread's `ThreadGroup` object acts as its handler.
`Unit`	`sleep(millis: Long)` Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds, subject to the precision and accuracy of system timers and schedulers. The thread does not lose ownership of any monitors.
`Unit`	`sleep(millis: Long, nanos: Int)` Causes the currently executing thread to sleep (temporarily cease execution) for the specified number of milliseconds plus the specified number of nanoseconds, subject to the precision and accuracy of system timers and schedulers. The thread does not lose ownership of any monitors.
`Unit`	`start()` Causes this thread to begin execution; the Java Virtual Machine calls the `run` method of this thread. The result is that two threads are running concurrently: the current thread (which returns from the call to the `start` method) and the other thread (which executes its `run` method). It is never legal to start a thread more than once. In particular, a thread may not be restarted once it has completed execution.
`Unit`	`stop()` Throws `UnsupportedOperationException`.
`Unit`	`stop(obj: Throwable?)` Throws `UnsupportedOperationException`.
`Unit`	`suspend()` Throws `UnsupportedOperationException`.
`String`	`toString()` Returns a string representation of this thread, including the thread's name, priority, and thread group.
`Unit`	`yield()` A hint to the scheduler that the current thread is willing to yield its current use of a processor. The scheduler is free to ignore this hint. Yield is a heuristic attempt to improve relative progression between threads that would otherwise over-utilise a CPU. Its use should be combined with detailed profiling and benchmarking to ensure that it actually has the desired effect. It is rarely appropriate to use this method. It may be useful for debugging or testing purposes, where it may help to reproduce bugs due to race conditions. It may also be useful when designing concurrency control constructs such as the ones in the `java.util.concurrent.locks` package.

Protected constructors

ForkJoinWorkerThread

Added in API level Baklava

protected ForkJoinWorkerThread(
    group: ThreadGroup!, 
    pool: ForkJoinPool!, 
    preserveThreadLocals: Boolean)

Creates a ForkJoinWorkerThread operating in the given thread group and pool, and with the given policy for preserving ThreadLocals.

Parameters
`group`	ThreadGroup!: if non-null, the thread group for this thread. Otherwise, the thread group is chosen by the security manager if present, else set to the current thread's thread group.
`pool`	ForkJoinPool!: the pool this thread works in
`preserveThreadLocals`	Boolean: if true, always preserve the values of ThreadLocal variables across tasks; otherwise they may be cleared.

Exceptions
`java.lang.NullPointerException`	if pool is null

ForkJoinWorkerThread

Added in API level 21

protected ForkJoinWorkerThread(pool: ForkJoinPool!)

Creates a ForkJoinWorkerThread operating in the given pool.

Parameters
`pool`	ForkJoinPool!: the pool this thread works in

Exceptions
`java.lang.NullPointerException`	if pool is null

Public methods

getPool

Added in API level 21

open fun getPool(): ForkJoinPool!

Returns the pool hosting this thread.

Return
`ForkJoinPool!`	the pool

getPoolIndex

Added in API level 21

open fun getPoolIndex(): Int

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.

Return
`Int`	the index number

getQueuedTaskCount

Added in API level Baklava

open fun getQueuedTaskCount(): Int

{@return a (non-negative) estimate of the number of tasks in the * thread's queue}

See Also

java.util.concurrent.ForkJoinPool#getQueuedTaskCount()

run

Added in API level 21

open fun run(): Unit

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

Protected methods

onStart

Added in API level 21

protected open fun onStart(): Unit

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.

onTermination

Added in API level 21

protected open fun onTermination(exception: Throwable!): Unit

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`	Throwable!: the exception causing this thread to abort due to an unrecoverable error, or `null` if completed normally