| public class java.lang Thread
|
Java SE 6 |
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:
exit method of class Runtime has been
called and the security manager has permitted the exit operation
to take place.
run method or by
throwing an exception that propagates beyond the run
method.
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.
| version | 1.173, 07/13/06 |
| since | JDK1.0 |
| See also | java.lang.Runnable, exit(int), run(), stop() |
| Fields | |
|---|---|
| final public static int | MIN_PRIORITY The minimum priority that a thread can have. |
| final public static int | NORM_PRIORITY The default priority that is assigned to a thread. |
| final public static int | MAX_PRIORITY The maximum priority that a thread can have. |
| Constructors | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public | Thread() Details
Allocates a new Thread object. This constructor has
the same effect as Thread(null, null,
gname), where gname is
a newly generated name. Automatically generated names are of the
form "Thread-"+n, where n is an integer.
| ||||||||||||
| public | Thread(Runnable target) Details
Allocates a new Thread object. This constructor has
the same effect as Thread(null, target,
gname), where gname is
a newly generated name. Automatically generated names are of the
form "Thread-"+n, where n is an integer.
| ||||||||||||
| public | Thread(ThreadGroup group, Runnable target) Details
Allocates a new Thread object. This constructor has
the same effect as Thread(group, target,
gname), where gname is
a newly generated name. Automatically generated names are of the
form "Thread-"+n, where n is an integer.
| ||||||||||||
| public | Thread(String name) Details
Allocates a new Thread object. This constructor has
the same effect as Thread(null, null, name).
| ||||||||||||
| public | Thread(ThreadGroup group, String name) Details
Allocates a new Thread object. This constructor has
the same effect as Thread(group, null, name)
| ||||||||||||
| public | Thread(Runnable target, String name) Details
Allocates a new Thread object. This constructor has
the same effect as Thread(null, target, name).
| ||||||||||||
| public | Thread(ThreadGroup group, Runnable target, String name) Details
Allocates a new Thread object so that it has
target as its run object, has the specified
name as its name, and belongs to the thread group
referred to by group.
If If there is a security manager, its In addition, its
If the
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
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
| ||||||||||||
| public | Thread(ThreadGroup group, Runnable target, String name, long stackSize) Details
Allocates a new Thread object so that it has
target as its run object, has the specified
name as its name, belongs to the thread group referred to
by group, and has the specified stack size.
This constructor is identical to On some platforms, specifying a higher value for the
stackSize parameter may allow a thread to achieve greater
recursion depth before throwing a 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.
| ||||||||||||
| Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public static int | activeCount() Details
Returns the number of active threads in the current thread's thread
group.
| ||||||||||
| final public void | checkAccess() Details
Determines if the currently running thread has permission to
modify this thread.
If there is a security manager, its
| ||||||||||
| public int | countStackFrames() Details
Counts the number of stack frames in this thread. The thread must
be suspended.
| ||||||||||
| public static Thread | currentThread() Details
Returns a reference to the currently executing thread object.
| ||||||||||
| public void | destroy() Details
Throws NoSuchMethodError.
| ||||||||||
| public static void | dumpStack() Details
Prints a stack trace of the current thread to the standard error stream.
This method is used only for debugging.
| ||||||||||
| public static int | enumerate(Thread[] tarray) Details
Copies into the specified array every active thread in
the current thread's thread group and its subgroups. This method simply
calls the enumerate method of the current thread's thread
group with the array argument.
First, if there is a security manager, that
| ||||||||||
| public static boolean | holdsLock(Object obj) Details
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);
| ||||||||||
| public void | interrupt() Details
Interrupts this thread.
Unless the current thread is interrupting itself, which is
always permitted, the If this thread is blocked in an invocation of the If this thread is blocked in an I/O operation upon an If this thread is blocked in a 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.
| ||||||||||
| public static boolean | interrupted() Details
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.
| ||||||||||
| final public void | join(long millis) throws InterruptedException Details
Waits at most millis milliseconds for this thread to
die. A timeout of 0 means to wait forever.
| ||||||||||
| final public void | join(long millis, int nanos) throws InterruptedException Details
Waits at most millis milliseconds plus
nanos nanoseconds for this thread to die.
| ||||||||||
| final public void | join() throws InterruptedException Details
Waits for this thread to die.
| ||||||||||
| final public void | resume() Details
Resumes a suspended thread.
First, the If the thread is alive but suspended, it is resumed and is permitted to make progress in its execution.
| ||||||||||
| public void | run() Details
If this thread was constructed using a separate
Runnable run object, then that
Runnable object's run method is called;
otherwise, this method does nothing and returns.
Subclasses of
| ||||||||||
| public static void | sleep(long millis) throws InterruptedException Details
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.
| ||||||||||
| public static void | sleep(long millis, int nanos) throws InterruptedException Details
Causes 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.
| ||||||||||
| public void | start() Details
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
It is never legal to start a thread more than once. In particular, a thread may not be restarted once it has completed execution.
| ||||||||||
| final public void | stop() Details
Forces the thread to stop executing.
If there is a security manager installed, its
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
The thread represented by this thread is forced to stop whatever
it is doing abnormally and to throw a newly created
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
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
| ||||||||||
| final public void | stop(Throwable obj) Details
Forces the thread to stop executing.
If there is a security manager installed, the
If this thread is different from the current thread (that is, the current
thread is trying to stop a thread other than itself) or
If the argument
The thread represented by this thread is forced to stop
whatever it is doing abnormally and to throw the
It is permitted to stop a thread that has not yet been started. If the thread is eventually started, it immediately terminates.
| ||||||||||
| final public void | suspend() Details
Suspends this thread.
First, the If the thread is alive, it is suspended and makes no further progress unless and until it is resumed.
| ||||||||||
| public String | toString() Details
Returns a string representation of this thread, including the
thread's name, priority, and thread group.
| ||||||||||
| public static void | yield() Causes the currently executing thread object to temporarily pause and allow other threads to execute. | ||||||||||
| Properties | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| final public boolean | isAlive() Details
Tests if this thread is alive. A thread is alive if it has
been started and has not yet died.
| ||||||||
| public static Map | getAllStackTraces() Details
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.
| ||||||||
| public void | setContextClassLoader(ClassLoader cl) Details
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
| ||||||||
| public ClassLoader | getContextClassLoader() Details
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
| ||||||||
| final public void | setDaemon(boolean on) Details
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
| ||||||||
| final public boolean | isDaemon() Details
Tests if this thread is a daemon thread.
| ||||||||
| public static void | setDefaultUncaughtExceptionHandler(Thread.UncaughtExceptionHandler eh) Details
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 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.
| ||||||||
| public static Thread.UncaughtExceptionHandler | getDefaultUncaughtExceptionHandler() Details
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.
| ||||||||
| public long | getId() Details
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.
| ||||||||
| public boolean | isInterrupted() Details
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.
| ||||||||
| final public void | setName(String name) Details
Changes the name of this thread to be equal to the argument
name.
First the
| ||||||||
| final public String | getName() Details
Returns this thread's name.
| ||||||||
| final public void | setPriority(int newPriority) Details
Changes the priority of this thread.
First the
Otherwise, the priority of this thread is set to the smaller of
the specified
| ||||||||
| final public int | getPriority() Details
Returns this thread's priority.
| ||||||||
| public StackTraceElement[] | getStackTrace() Details
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.
| ||||||||
| public Thread.State | getState() Details
Returns the state of this thread.
This method is designed for use in monitoring of the system state,
not for synchronization control.
| ||||||||
| final public ThreadGroup | getThreadGroup() Details
Returns the thread group to which this thread belongs.
This method returns null if this thread has died
(been stopped).
| ||||||||
| public void | setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler eh) Details
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.
| ||||||||
| public Thread.UncaughtExceptionHandler | getUncaughtExceptionHandler() Details
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.
| ||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|