Java Doc for Thread.java in  » 6.0-JDK-Core » lang » java » lang » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 exit method of class Runtime has 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 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.
author:
   unascribed
version:
   1.184, 07/30/07
See Also:   Runnable
See Also:   Runtime.exit(int)
See Also:   Thread.run()
See Also:   Thread.stop()
since:
   JDK1.0

If group is null and there is a security manager, the group is determined by the security manager's getThreadGroup method.

This constructor is identical to Thread.Thread(ThreadGroup,Runnable,String) with the exception of the fact that it allows the thread stack size to be specified.

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.

Unless the current thread is interrupting itself, which is always permitted, the Thread.checkAccess() 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 Object.wait wait() , Object.wait(long) wait(long) , or Object.wait(longint) 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 java.nio.channels.InterruptibleChannel interruptiblechannel 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 java.nio.channels.Selector.wakeup wakeup method were invoked.

If none of the previous conditions hold then this thread's interrupt status will be set.

This implementation uses a loop of this.wait calls conditioned on this.isAlive .

First, the checkAccess method of this thread is called with no arguments.

If there is a security manager installed, its checkAccess method is called with this as its argument.

If there is a security manager installed, the checkAccess method of this thread is called, which may result in a SecurityException being raised (in the current thread).

First, the checkAccess method of this thread is called with no arguments.

If group is null and there is a security manager, the group is determined by the security manager's getThreadGroup method. If group is null and there is not a security manager, or the security manager's getThreadGroup method returns null, 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 checkAccess method is called with the ThreadGroup as its argument.

In addition, its checkPermission method is called with the RuntimePermission("enableContextClassLoaderOverride") permission when invoked directly or indirectly by the constructor of a subclass which overrides the getContextClassLoader or setContextClassLoader methods. This may result in a SecurityException.

If the target argument is not null, the run method of the target is called when this thread is started. If the target argument is null, this thread's run method 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 setPriority may 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 setDaemon may be used to change whether or not a thread is a daemon.
Parameters:
  group - the thread group.
Parameters:
  target - the object whose run method is called.
Parameters:
  name - the name of the new thread.
exception:
  SecurityException - if the current thread cannot create athread in the specified thread group or cannotoverride the context class loader methods.
See Also:   Runnable.run
See Also:   Thread.run()
See Also:   Thread.setDaemon(boolean)
See Also:   Thread.setPriority(int)
See Also:   ThreadGroup.checkAccess
See Also:   SecurityManager.checkAccess

This constructor is identical to Thread.Thread(ThreadGroup,Runnable,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.
Parameters:
  group - the thread group.
Parameters:
  target - the object whose run method is called.
Parameters:
  name - the name of the new thread.
Parameters:
  stackSize - the desired stack size for the new thread, orzero to indicate that this parameter is to be ignored.
exception:
  SecurityException - if the current thread cannot create athread in the specified thread group.
since:
   1.4

If there is a security manager, its checkAccess method is called with this thread as its argument. This may result in throwing a SecurityException.
exception:
  SecurityException - if the current thread is not allowed toaccess this thread.
See Also:   SecurityManager.checkAccess(Thread)

First, if there is a security manager, that enumerate method calls the security manager's checkAccess method with the thread group as its argument. This may result in throwing a SecurityException.
Parameters:
  tarray - an array of Thread objects to copy to the number of threads put into the array
exception:
  SecurityException - if a security manager exists and its checkAccess method doesn't allow the operation.
See Also:   ThreadGroup.enumerate(Thread[])
See Also:   SecurityManager.checkAccess(ThreadGroup)

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. a Map from Thread to an array of StackTraceElement that represents the stack trace of the corresponding thread.
throws:
  SecurityException - if a security manager exists and its checkPermission method doesn't allow getting the stack trace of thread.
See Also:   Thread.getStackTrace
See Also:   SecurityManager.checkPermission
See Also:   RuntimePermission
See Also:   Throwable.getStackTrace
since:
   1.5

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 checkPermission method is called with a RuntimePermission("getClassLoader") permission to see if it's ok to get the context ClassLoader.. the context ClassLoader for this Thread
throws:
  SecurityException - if a security manager exists and its checkPermission method doesn't allow getting the context ClassLoader.
See Also:   Thread.setContextClassLoader
See Also:   SecurityManager.checkPermission
See Also:   RuntimePermission
since:
   1.2

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. an array of StackTraceElement, each represents one stack frame.
throws:
  SecurityException - if a security manager exists and its checkPermission method doesn't allow getting the stack trace of thread.
See Also:   SecurityManager.checkPermission
See Also:   RuntimePermission
See Also:   Throwable.getStackTrace
since:
   1.5

This method is designed to allow a program to assert that the current thread already holds a specified lock:

 assert Thread.holdsLock(obj);
 

Unless the current thread is interrupting itself, which is always permitted, the Thread.checkAccess() 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 Object.wait wait() , Object.wait(long) wait(long) , or Object.wait(longint) 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 java.nio.channels.InterruptibleChannel interruptiblechannel 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 java.nio.channels.Selector.wakeup wakeup method were invoked.

If none of the previous conditions hold then this thread's interrupt status will be set.

A thread interruption ignored because a thread was not alive at the time of the interrupt will be reflected by this method returning false. true if the current thread has been interrupted;false otherwise.
See Also:   Thread.isInterrupted()

A thread interruption ignored because a thread was not alive at the time of the interrupt will be reflected by this method returning false. true if this thread has been interrupted;false otherwise.
See Also:   Thread.interrupted()

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.
Parameters:
  millis - the time to wait in milliseconds
throws:
  IllegalArgumentException - if the value of millis is negative
throws:
  InterruptedException - if any thread has interrupted the current thread. Theinterrupted status of the current thread iscleared when this exception is thrown.

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.
Parameters:
  millis - the time to wait in milliseconds
Parameters:
  nanos - 0-999999 additional nanoseconds to wait
throws:
  IllegalArgumentException - if the value of millis is negative, or the valueof nanos is not in the range 0-999999
throws:
  InterruptedException - if any thread has interrupted the current thread. Theinterrupted status of the current thread iscleared when this exception is thrown.

An invocation of this method behaves in exactly the same way as the invocation

(0)

First, the checkAccess method of this thread is called with no arguments. This may result in throwing a SecurityException (in the current thread).

If the thread is alive but suspended, it is resumed and is permitted to make progress in its execution.
exception:
  SecurityException - if the current thread cannot modify thisthread.
See Also:   Thread.checkAccess
See Also:   Thread.suspend()Thread.suspend

Subclasses of Thread should override this method.
See Also:   Thread.start()
See Also:   Thread.stop()
See Also:   Thread.Thread(ThreadGroup,Runnable,String)

First, if there is a security manager, its checkPermission method is called with a RuntimePermission("setContextClassLoader") permission to see if it's ok to set the context ClassLoader..
Parameters:
  cl - the context ClassLoader for this Thread
exception:
  SecurityException - if the current thread cannot set the context ClassLoader.
See Also:   Thread.getContextClassLoader
See Also:   SecurityManager.checkPermission
See Also:   RuntimePermission
since:
   1.2

This method must be invoked before the thread is started.
Parameters:
  on - if true , marks this thread as a daemon thread
throws:
  IllegalThreadStateException - if this thread is
throws:
  SecurityException - if Thread.checkAccess determines that the currentthread cannot modify this 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.
Parameters:
  eh - the object to use as the default uncaught exception handler.If null then there is no default handler.
throws:
  SecurityException - if a security manager is present and itdenies RuntimePermission("setDefaultUncaughtExceptionHandler")
See Also:   Thread.setUncaughtExceptionHandler
See Also:   Thread.getUncaughtExceptionHandler
See Also:   ThreadGroup.uncaughtException
since:
   1.5

First the checkAccess method of this thread is called with no arguments. This may result in throwing a SecurityException.
Parameters:
  name - the new name for this thread.
exception:
  SecurityException - if the current thread cannot modify thisthread.
See Also:   Thread.getName
See Also:   Thread.checkAccess()

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.
Parameters:
  newPriority - priority to set this thread to
exception:
  IllegalArgumentException - If the priority is not in therange MIN_PRIORITY toMAX_PRIORITY.
exception:
  SecurityException - if the current thread cannot modifythis thread.
See Also:   Thread.getPriority
See Also:   Thread.checkAccess()
See Also:   Thread.getThreadGroup()
See Also:   Thread.MAX_PRIORITY
See Also:   Thread.MIN_PRIORITY
See Also:   ThreadGroup.getMaxPriority

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.
Parameters:
  eh - the object to use as this thread's uncaught exceptionhandler. If null then this thread has no explicit handler.
throws:
  SecurityException - if the current thread is not allowed tomodify this thread.
See Also:   Thread.setDefaultUncaughtExceptionHandler
See Also:   ThreadGroup.uncaughtException
since:
   1.5

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.
exception:
  IllegalThreadStateException - if the thread was alreadystarted.
See Also:   Thread.run()
See Also:   Thread.stop()

If there is a security manager installed, its checkAccess method is called with this as its argument. This may result in a SecurityException being 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 checkPermission method (with a RuntimePermission("stopThread") argument) is called in addition. Again, this may result in throwing a SecurityException (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 ThreadDeath object 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 ThreadDeath unless it must do some extraordinary cleanup operation (note that the throwing of ThreadDeath causes finally clauses of try statements to be executed before the thread officially dies). If a catch clause catches a ThreadDeath object, 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.
exception:
  SecurityException - if the current thread cannot modify this thread.
See Also:   Thread.interrupt()
See Also:   Thread.checkAccess()
See Also:   Thread.run()
See Also:   Thread.start()
See Also:   ThreadDeath
See Also:   ThreadGroup.uncaughtException(ThreadThrowable)
See Also:   SecurityManager.checkAccess(Thread)
See Also:   SecurityManager.checkPermission

If there is a security manager installed, the checkAccess method of this thread is called, which may result in a SecurityException being 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 obj is not an instance of ThreadDeath, the security manager's checkPermission method (with the RuntimePermission("stopThread") argument) is called in addition. Again, this may result in throwing a SecurityException (in the current thread).

If the argument obj is null, a NullPointerException is thrown (in the current thread).

The thread represented by this thread is forced to stop whatever it is doing abnormally and to throw the Throwable object obj as an exception. This is an unusual action to take; normally, the stop method 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.
Parameters:
  obj - the Throwable object to be thrown.
exception:
  SecurityException - if the current thread cannot modifythis thread.
throws:
  NullPointerException - if obj is null.
See Also:   Thread.interrupt()
See Also:   Thread.checkAccess()
See Also:   Thread.run()
See Also:   Thread.start()
See Also:   Thread.stop()
See Also:   SecurityManager.checkAccess(Thread)
See Also:   SecurityManager.checkPermissionThread.stop()

First, the checkAccess method of this thread is called with no arguments. This may result in throwing a SecurityException (in the current thread).

If the thread is alive, it is suspended and makes no further progress unless and until it is resumed.
exception:
  SecurityException - if the current thread cannot modifythis thread.
See Also:   Thread.checkAccess