Class: java.lang.Thread
- public class Thread
- implements Runnable
Every thread has a priority. Threads with higher priority are
executed in preference to threads with lower priority. Each thread
may or may not also be marked as a daemon. When code running in
some thread creates a new Thread object, the new
thread has its priority initially set equal to the priority of the
creating thread, and is a daemon thread if and only if the
creating thread is a daemon.
When a Java Virtual Machine starts up, there is usually a single
non-daemon thread (which typically calls the method named
main of some designated class). The Java Virtual
Machine continues to execute threads until either of the following
occurs:
- The
exitmethod of classRuntimehas been called and the security manager has permitted the exit operation to take place. - All threads that are not daemon threads have died, either by
returning from the call to the
runmethod or by throwing an exception that propagates beyond therunmethod.
There are two ways to create a new thread of execution. One is to
declare a class to be a subclass of Thread. This
subclass should override the run method of class
Thread. An instance of the subclass can then be
allocated and started. For example, a thread that computes primes
larger than a stated value could be written as follows:
class PrimeThread extends Thread {
long minPrime;
PrimeThread(long minPrime) {
this.minPrime = minPrime;
}
public void run() {
// compute primes larger than minPrime
. . .
}
}
The following code would then create a thread and start it running:
PrimeThread p = new PrimeThread(143);
p.start();
The other way to create a thread is to declare a class that
implements the Runnable interface. That class then
implements the run method. An instance of the class can
then be allocated, passed as an argument when creating
Thread, and started. The same example in this other
style looks like the following:
class PrimeRun implements Runnable {
long minPrime;
PrimeRun(long minPrime) {
this.minPrime = minPrime;
}
public void run() {
// compute primes larger than minPrime
. . .
}
}
The following code would then create a thread and start it running:
PrimeRun p = new PrimeRun(143);
new Thread(p).start();
Every thread has a name for identification purposes. More than one thread may have the same name. If a name is not specified when a thread is created, a new name is generated for it.
Methods
-
Threadtop
public Thread()Allocates a newThreadobject. This constructor has the same effect asThread(null, null,gname), where gname is a newly generated name. Automatically generated names are of the form"Thread-"+n, where n is an integer. -
Threadtop
public Thread(Runnable target)Allocates a newThreadobject. This constructor has the same effect asThread(null, target,gname), where gname is a newly generated name. Automatically generated names are of the form"Thread-"+n, where n is an integer. -
Threadtop
Allocates a newThreadobject. This constructor has the same effect asThread(null, target, name). -
Threadtop
public Thread(String name)Allocates a newThreadobject. This constructor has the same effect asThread(null, null, name). -
Threadtop
public Thread(ThreadGroup group, Runnable target)Allocates a newThreadobject. This constructor has the same effect asThread(group, target,gname), where gname is a newly generated name. Automatically generated names are of the form"Thread-"+n, where n is an integer. -
Threadtop
Allocates a newThreadobject so that it hastargetas its run object, has the specifiednameas its name, and belongs to the thread group referred to bygroup.If
groupisnulland there is a security manager, the group is determined by the security manager'sgetThreadGroupmethod. Ifgroupisnulland there is not a security manager, or the security manager'sgetThreadGroupmethod returnsnull, the group is set to be the same ThreadGroup as the thread that is creating the new thread.If there is a security manager, its
checkAccessmethod is called with the ThreadGroup as its argument.In addition, its
checkPermissionmethod is called with theRuntimePermission("enableContextClassLoaderOverride")permission when invoked directly or indirectly by the constructor of a subclass which overrides thegetContextClassLoaderorsetContextClassLoadermethods. This may result in a SecurityException.If the
targetargument is notnull, therunmethod of thetargetis called when this thread is started. If the target argument isnull, this thread'srunmethod is called when this thread is started.The priority of the newly created thread is set equal to the priority of the thread creating it, that is, the currently running thread. The method
setPrioritymay be used to change the priority to a new value.The newly created thread is initially marked as being a daemon thread if and only if the thread creating it is currently marked as a daemon thread. The method
setDaemonmay be used to change whether or not a thread is a daemon. -
Threadtop
Allocates a newThreadobject so that it hastargetas its run object, has the specifiednameas its name, belongs to the thread group referred to bygroup, and has the specified stack size.This constructor is identical to Thread.Thread(java.lang.ThreadGroup, java.lang.Runnable, java.lang.String) with the exception of the fact that it allows the thread stack size to be specified. The stack size is the approximate number of bytes of address space that the virtual machine is to allocate for this thread's stack. The effect of the stackSize parameter, if any, is highly platform dependent.
On some platforms, specifying a higher value for the stackSize parameter may allow a thread to achieve greater recursion depth before throwing a StackOverflowError. Similarly, specifying a lower value may allow a greater number of threads to exist concurrently without throwing an OutOfMemoryError (or other internal error). The details of the relationship between the value of the stackSize parameter and the maximum recursion depth and concurrency level are platform-dependent. On some platforms, the value of the stackSize parameter may have no effect whatsoever.
The virtual machine is free to treat the stackSize parameter as a suggestion. If the specified value is unreasonably low for the platform, the virtual machine may instead use some platform-specific minimum value; if the specified value is unreasonably high, the virtual machine may instead use some platform-specific maximum. Likewise, the virtual machine is free to round the specified value up or down as it sees fit (or to ignore it completely).
Specifying a value of zero for the stackSize parameter will cause this constructor to behave exactly like the Thread(ThreadGroup, Runnable, String) constructor.
Due to the platform-dependent nature of the behavior of this constructor, extreme care should be exercised in its use. The thread stack size necessary to perform a given computation will likely vary from one JRE implementation to another. In light of this variation, careful tuning of the stack size parameter may be required, and the tuning may need to be repeated for each JRE implementation on which an application is to run.
Implementation note: Java platform implementers are encouraged to document their implementation's behavior with respect to the stackSize parameter.
-
Threadtop
public Thread(ThreadGroup group, String name)Allocates a newThreadobject. This constructor has the same effect asThread(group, null, name) -
activeCounttop
public static int activeCount()Returns the number of active threads in the current thread's thread group. -
auditSubclasstop
static private boolean auditSubclass(Class subcl)Performs reflective checks on given subclass to verify that it doesn't override security-sensitive non-final methods. Returns true if the subclass overrides any of the methods, false otherwise. -
blockedOntop
void blockedOn(Interruptible b) -
checkAccesstop
public final void checkAccess()Determines if the currently running thread has permission to modify this thread.If there is a security manager, its
checkAccessmethod is called with this thread as its argument. This may result in throwing aSecurityException. -
countStackFramestop
public native int countStackFrames()Counts the number of stack frames in this thread. The thread must be suspended. -
currentThreadtop
public static native Thread currentThread()Returns a reference to the currently executing thread object. -
destroytop
public void destroy()Throws NoSuchMethodError. -
dispatchUncaughtExceptiontop
private void dispatchUncaughtException(Throwable e)Dispatch an uncaught exception to the handler. This method is intended to be called only by the JVM. -
dumpStacktop
public static void dumpStack()Prints a stack trace of the current thread to the standard error stream. This method is used only for debugging. -
dumpThreadstop
static native private StackTraceElement[][] dumpThreads(Thread[] threads) -
enumeratetop
public static int enumerate(Thread[] tarray)Copies into the specified array every active thread in the current thread's thread group and its subgroups. This method simply calls theenumeratemethod of the current thread's thread group with the array argument.First, if there is a security manager, that
enumeratemethod calls the security manager'scheckAccessmethod with the thread group as its argument. This may result in throwing aSecurityException. -
exittop
private void exit()This method is called by the system to give a Thread a chance to clean up before it actually exits. -
getAllStackTracestop
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.
If there is a security manager, then the security manager's checkPermission method is called with a RuntimePermission("getStackTrace") permission as well as RuntimePermission("modifyThreadGroup") permission to see if it is ok to get the stack trace of all threads.
-
getContextClassLoadertop
public 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.First, if there is a security manager, and the caller's class loader is not null and the caller's class loader is not the same as or an ancestor of the context class loader for the thread whose context class loader is being requested, then the security manager's
checkPermissionmethod is called with aRuntimePermission("getClassLoader")permission to see if it's ok to get the context ClassLoader.. -
getDefaultUncaughtExceptionHandlertop
public static 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. -
getIdtop
public 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. -
getNametop
public final String getName()Returns this thread's name. -
getPrioritytop
public final int getPriority()Returns this thread's priority. -
getStackTracetop
public 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 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.
-
getStatetop
Returns the state of this thread. This method is designed for use in monitoring of the system state, not for synchronization control. -
getThreadGrouptop
public final ThreadGroup getThreadGroup()Returns the thread group to which this thread belongs. This method returns null if this thread has died (been stopped). -
getThreadstop
static native private Thread[] getThreads() -
getUncaughtExceptionHandlertop
public 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. -
holdsLocktop
public static native boolean holdsLock(Object obj)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); -
inittop
Initializes a Thread. -
interrupttop
public void 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 Thread.join(), Thread.join(long), Thread.join(long, int), Thread.sleep(long), or Thread.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 interruptible channel
then the channel will be closed, the thread's interrupt status will be set, and the thread will receive a java.nio.channels.ClosedByInterruptException.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.
-
interrupt0top
native private void interrupt0() -
interruptedtop
public static 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.
-
isAlivetop
public final native boolean isAlive()Tests if this thread is alive. A thread is alive if it has been started and has not yet died. -
isCCLOverriddentop
static private boolean isCCLOverridden(Class cl)Verifies that this (possibly subclass) instance can be constructed without violating security constraints: the subclass must not override security-sensitive non-final methods, or else the "enableContextClassLoaderOverride" RuntimePermission is checked. -
isDaemontop
public final boolean isDaemon()Tests if this thread is a daemon thread. -
isInterruptedtop
public 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.
-
isInterruptedtop
native private boolean isInterrupted(boolean ClearInterrupted)Tests if some Thread has been interrupted. The interrupted state is reset or not based on the value of ClearInterrupted that is passed. -
jointop
public final void join() throws InterruptedExceptionWaits for this thread to die. -
jointop
public final synchronized void join(long millis) throws InterruptedExceptionWaits at mostmillismilliseconds for this thread to die. A timeout of0means to wait forever. -
jointop
public final synchronized void join(long millis, int nanos) throws InterruptedExceptionWaits at mostmillismilliseconds plusnanosnanoseconds for this thread to die. -
nextThreadIDtop
static synchronized private long nextThreadID() -
nextThreadNumtop
static synchronized private int nextThreadNum() -
registerNativestop
static native private void registerNatives()- Override hierarchy:
- registerNatives from Object
-
resumetop
public final void resume()Resumes a suspended thread.First, the
checkAccessmethod of this thread is called with no arguments. This may result in throwing aSecurityException(in the current thread).If the thread is alive but suspended, it is resumed and is permitted to make progress in its execution.
-
resume0top
native private void resume0() -
runtop
public void run()If this thread was constructed using a separateRunnablerun object, then thatRunnableobject'srunmethod is called; otherwise, this method does nothing and returns.Subclasses of
Threadshould override this method. -
setContextClassLoadertop
public void setContextClassLoader(ClassLoader cl)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 to code running in the thread when loading classes and resources.First, if there is a security manager, its
checkPermissionmethod is called with aRuntimePermission("setContextClassLoader")permission to see if it's ok to set the context ClassLoader.. -
setDaemontop
public final void setDaemon(boolean on)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 called before the thread is started.
This method first calls the
checkAccessmethod of this thread with no arguments. This may result in throwing aSecurityException(in the current thread). -
setDefaultUncaughtExceptionHandlertop
public static void setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler eh)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.
-
setNametop
public final void setName(String name)Changes the name of this thread to be equal to the argumentname.First the
checkAccessmethod of this thread is called with no arguments. This may result in throwing aSecurityException. -
setPrioritytop
public final void setPriority(int newPriority)Changes the priority of this thread.First the
checkAccessmethod of this thread is called with no arguments. This may result in throwing aSecurityException.Otherwise, the priority of this thread is set to the smaller of the specified
newPriorityand the maximum permitted priority of the thread's thread group. -
setPriority0top
native private void setPriority0(int newPriority) -
setUncaughtExceptionHandlertop
public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler eh)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.
-
sleeptop
public static native void sleep(long millis) throws InterruptedExceptionCauses 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. -
sleeptop
public static void sleep(long millis, int nanos) throws InterruptedExceptionCauses the currently executing thread to sleep (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. -
starttop
public synchronized void start()Causes this thread to begin execution; the Java Virtual Machine calls therunmethod of this thread.The result is that two threads are running concurrently: the current thread (which returns from the call to the
startmethod) and the other thread (which executes itsrunmethod).It is never legal to start a thread more than once. In particular, a thread may not be restarted once it has completed execution.
-
start0top
native private void start0() -
stoptop
public final void stop()Forces the thread to stop executing.If there is a security manager installed, its
checkAccessmethod is called withthisas its argument. This may result in aSecurityExceptionbeing raised (in the current thread).If this thread is different from the current thread (that is, the current thread is trying to stop a thread other than itself), the security manager's
checkPermissionmethod (with aRuntimePermission("stopThread")argument) is called in addition. Again, this may result in throwing aSecurityException(in the current thread).The thread represented by this thread is forced to stop whatever it is doing abnormally and to throw a newly created
ThreadDeathobject as an exception.It is permitted to stop a thread that has not yet been started. If the thread is eventually started, it immediately terminates.
An application should not normally try to catch
ThreadDeathunless it must do some extraordinary cleanup operation (note that the throwing ofThreadDeathcausesfinallyclauses oftrystatements to be executed before the thread officially dies). If acatchclause catches aThreadDeathobject, it is important to rethrow the object so that the thread actually dies.The top-level error handler that reacts to otherwise uncaught exceptions does not print out a message or otherwise notify the application if the uncaught exception is an instance of
ThreadDeath. -
stoptop
public final synchronized void stop(Throwable obj)Forces the thread to stop executing.If there is a security manager installed, the
checkAccessmethod of this thread is called, which may result in aSecurityExceptionbeing raised (in the current thread).If this thread is different from the current thread (that is, the current thread is trying to stop a thread other than itself) or
objis not an instance ofThreadDeath, the security manager'scheckPermissionmethod (with theRuntimePermission("stopThread")argument) is called in addition. Again, this may result in throwing aSecurityException(in the current thread).If the argument
objis null, aNullPointerExceptionis thrown (in the current thread).The thread represented by this thread is forced to stop whatever it is doing abnormally and to throw the
Throwableobjectobjas an exception. This is an unusual action to take; normally, thestopmethod that takes no arguments should be used.It is permitted to stop a thread that has not yet been started. If the thread is eventually started, it immediately terminates.
-
stop0top
native private void stop0(Object o) -
stop1top
final synchronized private void stop1(Throwable th)Common impl for stop() and stop(Throwable). -
suspendtop
public final void suspend()Suspends this thread.First, the
checkAccessmethod of this thread is called with no arguments. This may result in throwing aSecurityException(in the current thread).If the thread is alive, it is suspended and makes no further progress unless and until it is resumed.
-
suspend0top
native private void suspend0() -
toStringtop
public String toString()Returns a string representation of this thread, including the thread's name, priority, and thread group. -
yieldtop
public static native void yield()Causes the currently executing thread object to temporarily pause and allow other threads to execute.
Fields
-
EMPTY_STACK_TRACE
static final private StackTraceElement[] EMPTY_STACK_TRACE -
MAX_PRIORITY
public static final int MAX_PRIORITY = 10The maximum priority that a thread can have. -
MIN_PRIORITY
public static final int MIN_PRIORITY = 1The minimum priority that a thread can have. -
NORM_PRIORITY
public static final int NORM_PRIORITY = 5The default priority that is assigned to a thread. -
SUBCLASS_IMPLEMENTATION_PERMISSION
static final private RuntimePermission SUBCLASS_IMPLEMENTATION_PERMISSION -
blocker
volatile private Interruptible blocker -
blockerLock
private Object blockerLock -
contextClassLoader
private ClassLoader contextClassLoader -
daemon
private boolean daemon -
defaultUncaughtExceptionHandler
static volatile private Thread.UncaughtExceptionHandler defaultUncaughtExceptionHandler -
eetop
private long eetop -
group
private ThreadGroup group -
inheritableThreadLocals
ThreadLocal.ThreadLocalMap inheritableThreadLocals -
inheritedAccessControlContext
private AccessControlContext inheritedAccessControlContext -
name
private char[] name -
nativeParkEventPointer
private long nativeParkEventPointer -
parkBlocker
volatile Object parkBlockerThe argument supplied to the current call to java.util.concurrent.locks.LockSupport.park. Set by (private) java.util.concurrent.locks.LockSupport.setBlocker Accessed using java.util.concurrent.locks.LockSupport.getBlocker -
priority
private int priority -
single_step
private boolean single_step -
stackSize
private long stackSize -
stillborn
private boolean stillborn -
stopBeforeStart
private boolean stopBeforeStart -
subclassAudits
static final private SoftCache subclassAuditscache of subclass security audit results -
target
private Runnable target -
threadInitNumber
static private int threadInitNumber -
threadLocals
ThreadLocal.ThreadLocalMap threadLocals -
threadQ
private Thread threadQ -
threadSeqNumber
static private long threadSeqNumber -
threadStatus
private int threadStatus -
throwableFromStop
private Throwable throwableFromStop -
tid
private long tid -
uncaughtExceptionHandler
volatile private Thread.UncaughtExceptionHandler uncaughtExceptionHandler
