public class java.lang
ThreadGroup


Show All Login
Java SE 6
  
Implements: Thread.UncaughtExceptionHandler
Details
A thread group represents a set of threads. In addition, a thread group can also include other thread groups. The thread groups form a tree in which every thread group except the initial thread group has a parent.

A thread is allowed to access information about its own thread group, but not to access information about its thread group's parent thread group or any other thread groups.
version1.65, 11/17/05
sinceJDK1.0


Constructors
public ThreadGroup(String name) Details
Constructs a new thread group. The parent of this new group is the thread group of the currently running thread.

The checkAccess method of the parent thread group is called with no arguments; this may result in a security exception.
namethe name of the new thread group.
ThrowsSecurityException: if the current thread cannot create a thread in the specified thread group.
sinceJDK1.0
See also checkAccess()

public ThreadGroup(ThreadGroup parent, String name) Details
Creates a new thread group. The parent of this new group is the specified thread group.

The checkAccess method of the parent thread group is called with no arguments; this may result in a security exception.
parentthe parent thread group.
namethe name of the new thread group.
ThrowsNullPointerException: if the thread group argument is null.
ThrowsSecurityException: if the current thread cannot create a thread in the specified thread group.
sinceJDK1.0
See also java.lang.SecurityException, checkAccess()


Methods
public int activeCount() Details
Returns an estimate of the number of active threads in this thread group. The result might not reflect concurrent activity, and might be affected by the presence of certain system threads.

Due to the inherently imprecise nature of the result, it is recommended that this method only be used for informational purposes.
returnan estimate of the number of active threads in this thread group and in any other thread group that has this thread group as an ancestor.
sinceJDK1.0

public int activeGroupCount() Details
Returns an estimate of the number of active groups in this thread group. The result might not reflect concurrent activity.

Due to the inherently imprecise nature of the result, it is recommended that this method only be used for informational purposes.
returnthe number of active thread groups with this thread group as an ancestor.
sinceJDK1.0

public boolean
allowThreadSuspension(boolean b)
Details
Used by VM to control lowmem implicit suspension.
bboolean to allow or disallow suspension
returntrue on success
sinceJDK1.1
deprecatedThe definition of this call depends on #suspend, which is deprecated. Further, the behavior of this call was never specified.
final public void checkAccess() Details
Determines if the currently running thread has permission to modify this thread group.

If there is a security manager, its checkAccess method is called with this thread group as its argument. This may result in throwing a SecurityException.
ThrowsSecurityException: if the current thread is not allowed to access this thread group.
sinceJDK1.0
See also checkAccess(java.lang.ThreadGroup)

final public void destroy() Details
Destroys this thread group and all of its subgroups. This thread group must be empty, indicating that all threads that had been in this thread group have since stopped.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.
ThrowsIllegalThreadStateException: if the thread group is not empty or if the thread group has already been destroyed.
ThrowsSecurityException: if the current thread cannot modify this thread group.
sinceJDK1.0
See also checkAccess()

public int enumerate(Thread[] list) Details
Copies into the specified array every active thread in this thread group and its subgroups.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

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 this thread group and its subgroups, the caller should verify that the returned int value is strictly less than the length of list.

Due to the inherent race condition in this method, it is recommended that the method only be used for informational purposes.
listan array into which to place the list of threads.
returnthe number of threads put into the array.
ThrowsSecurityException: if the current thread does not have permission to enumerate this thread group.
sinceJDK1.0
See also activeCount(), checkAccess()

public int enumerate(Thread[] list, boolean recurse) Details
Copies into the specified array every active thread in this thread group. If the recurse flag is true, references to every active thread in this thread's subgroups are also included. If the array is too short to hold all the threads, the extra threads are silently ignored.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

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 this thread group, the caller should verify that the returned int value is strictly less than the length of list.

Due to the inherent race condition in this method, it is recommended that the method only be used for informational purposes.
listan array into which to place the list of threads.
recursea flag indicating whether also to include threads in thread groups that are subgroups of this thread group.
returnthe number of threads placed into the array.
ThrowsSecurityException: if the current thread does not have permission to enumerate this thread group.
sinceJDK1.0
See also activeCount(), checkAccess()

public int enumerate(ThreadGroup[] list) Details
Copies into the specified array references to every active subgroup in this thread group.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

An application might use the activeGroupCount method to get an estimate of how big the array should be, however if the array is too short to hold all the thread groups, the extra thread groups are silently ignored. If it is critical to obtain every active subgroup in this thread group, the caller should verify that the returned int value is strictly less than the length of list.

Due to the inherent race condition in this method, it is recommended that the method only be used for informational purposes.
listan array into which to place the list of thread groups.
returnthe number of thread groups put into the array.
ThrowsSecurityException: if the current thread does not have permission to enumerate this thread group.
sinceJDK1.0
See also activeGroupCount(), checkAccess()

public int enumerate(ThreadGroup[] list, boolean recurse) Details
Copies into the specified array references to every active subgroup in this thread group. If the recurse flag is true, references to all active subgroups of the subgroups and so forth are also included.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

An application might use the activeGroupCount method to get an estimate of how big the array should be, however if the array is too short to hold all the thread groups, the extra thread groups are silently ignored. If it is critical to obtain every active subgroup in this thread group, the caller should verify that the returned int value is strictly less than the length of list.

Due to the inherent race condition in this method, it is recommended that the method only be used for informational purposes.
listan array into which to place the list of threads.
recursea flag indicating whether to recursively enumerate all included thread groups.
returnthe number of thread groups put into the array.
ThrowsSecurityException: if the current thread does not have permission to enumerate this thread group.
sinceJDK1.0
See also activeGroupCount(), checkAccess()

final public void interrupt() Details
Interrupts all threads in this thread group.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

This method then calls the interrupt method on all the threads in this thread group and in all of its subgroups.
ThrowsSecurityException: if the current thread is not allowed to access this thread group or any of the threads in the thread group.
since1.2
See also interrupt(), java.lang.SecurityException, checkAccess()

public void list() Details
Prints information about this thread group to the standard output. This method is useful only for debugging.
sinceJDK1.0
final public boolean parentOf(ThreadGroup g) Details
Tests if this thread group is either the thread group argument or one of its ancestor thread groups.
ga thread group.
returntrue if this thread group is the thread group argument or one of its ancestor thread groups; false otherwise.
sinceJDK1.0
final public void
resume()
Details
Resumes all threads in this thread group.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

This method then calls the resume method on all the threads in this thread group and in all of its sub groups.
ThrowsSecurityException: if the current thread is not allowed to access this thread group or any of the threads in the thread group.
sinceJDK1.0
deprecatedThis method is used solely in conjunction with Thread.suspend and ThreadGroup.suspend, both of which have been deprecated, as they are inherently deadlock-prone. See Thread#suspend for details.
See also java.lang.SecurityException, resume(), checkAccess()

final public void
stop()
Details
Stops all threads in this thread group.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

This method then calls the stop method on all the threads in this thread group and in all of its subgroups.
ThrowsSecurityException: if the current thread is not allowed to access this thread group or any of the threads in the thread group.
sinceJDK1.0
deprecatedThis method is inherently unsafe. See Thread#stop for details.
See also java.lang.SecurityException, stop(), checkAccess()

final public void
suspend()
Details
Suspends all threads in this thread group.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

This method then calls the suspend method on all the threads in this thread group and in all of its subgroups.
ThrowsSecurityException: if the current thread is not allowed to access this thread group or any of the threads in the thread group.
sinceJDK1.0
deprecatedThis method is inherently deadlock-prone. See Thread#suspend for details.
See also suspend(), java.lang.SecurityException, checkAccess()

public String toString() Details
Returns a string representation of this Thread group.
returna string representation of this thread group.
sinceJDK1.0
public void uncaughtException(Thread t, Throwable e) Details
Called by the Java Virtual Machine when a thread in this thread group stops because of an uncaught exception, and the thread does not have a specific Thread.UncaughtExceptionHandler installed.

The uncaughtException method of ThreadGroup does the following:

  • If this thread group has a parent thread group, the uncaughtException method of that parent is called with the same two arguments.
  • Otherwise, this method checks to see if there is a default uncaught exception handler installed, and if so, its uncaughtException method is called with the same two arguments.
  • Otherwise, this method determines if the Throwable argument is an instance of ThreadDeath. If so, nothing special is done. Otherwise, a message containing the thread's name, as returned from the thread's getName method, and a stack backtrace, using the Throwable's printStackTrace method, is printed to the standard error stream.

Applications can override this method in subclasses of ThreadGroup to provide alternative handling of uncaught exceptions.
tthe thread that is about to exit.
ethe uncaught exception.
sinceJDK1.0


Properties
final public void setDaemon(boolean daemon) Details
Changes the daemon status of this thread group.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

A daemon thread group is automatically destroyed when its last thread is stopped or its last thread group is destroyed.
daemonif true, marks this thread group as a daemon thread group; otherwise, marks this thread group as normal.
ThrowsSecurityException: if the current thread cannot modify this thread group.
sinceJDK1.0
See also java.lang.SecurityException, checkAccess()

final public boolean isDaemon() Details
Tests if this thread group is a daemon thread group. A daemon thread group is automatically destroyed when its last thread is stopped or its last thread group is destroyed.
returntrue if this thread group is a daemon thread group; false otherwise.
sinceJDK1.0
public boolean isDestroyed() Details
Tests if this thread group has been destroyed.
returntrue if this object is destroyed
sinceJDK1.1
final public void setMaxPriority(int pri) Details
Sets the maximum priority of the group. Threads in the thread group that already have a higher priority are not affected.

First, the checkAccess method of this thread group is called with no arguments; this may result in a security exception.

If the pri argument is less than Thread#MIN_PRIORITY or greater than Thread#MAX_PRIORITY, the maximum priority of the group remains unchanged.

Otherwise, the priority of this ThreadGroup object is set to the smaller of the specified pri and the maximum permitted priority of the parent of this thread group. (If this thread group is the system thread group, which has no parent, then its maximum priority is simply set to pri.) Then this method is called recursively, with pri as its argument, for every thread group that belongs to this thread group.
prithe new priority of the thread group.
ThrowsSecurityException: if the current thread cannot modify this thread group.
sinceJDK1.0
See also getMaxPriority, java.lang.SecurityException, checkAccess()

final public int getMaxPriority() Details
Returns the maximum priority of this thread group. Threads that are part of this group cannot have a higher priority than the maximum priority.
returnthe maximum priority that a thread in this thread group can have.
sinceJDK1.0
See also setMaxPriority
final public String getName() Details
Returns the name of this thread group.
returnthe name of this thread group.
sinceJDK1.0
final public ThreadGroup getParent() Details
Returns the parent of this thread group.

First, if the parent is not null, the checkAccess method of the parent thread group is called with no arguments; this may result in a security exception.
returnthe parent of this thread group. The top-level thread group is the only thread group whose parent is null.
ThrowsSecurityException: if the current thread cannot modify this thread group.
sinceJDK1.0
See also checkAccess(), java.lang.SecurityException, java.lang.RuntimePermission