Home » openjdk-7 » java » lang » [javadoc | source]
java.lang
public class: ThreadGroup [javadoc | source]
java.lang.Object
   java.lang.ThreadGroup

All Implemented Interfaces:
    UncaughtExceptionHandler

Direct Known Subclasses:
   

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.

Field Summary
 String name     
 int maxPriority     
 boolean destroyed     
 boolean daemon     
 boolean vmAllowSuspension     
 int nUnstartedThreads     
 int nthreads     
 Thread[] threads     
 int ngroups     
 ThreadGroup[] groups     
Constructor:
 public ThreadGroup(String name) 
    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.

    Parameters:
    name - the name of the new thread group.
    Throws:
    SecurityException - if the current thread cannot create a thread in the specified thread group.
    Also see:
    java.lang.ThreadGroup#checkAccess()
    exception: SecurityException - if the current thread cannot create a thread in the specified thread group.
    since: JDK1.0 -
 public ThreadGroup(ThreadGroup parent,
    String name) 
    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.

    Parameters:
    parent - the parent thread group.
    name - the name of the new thread group.
    Throws:
    NullPointerException - if the thread group argument is null.
    SecurityException - if the current thread cannot create a thread in the specified thread group.
    Also see:
    java.lang.SecurityException
    java.lang.ThreadGroup#checkAccess()
    exception: NullPointerException - if the thread group argument is null.
    exception: SecurityException - if the current thread cannot create a thread in the specified thread group.
    since: JDK1.0 -
Method from java.lang.ThreadGroup Summary:
activeCount,   activeGroupCount,   add,   addUnstarted,   allowThreadSuspension,   checkAccess,   destroy,   enumerate,   enumerate,   enumerate,   enumerate,   getMaxPriority,   getName,   getParent,   interrupt,   isDaemon,   isDestroyed,   list,   list,   parentOf,   resume,   setDaemon,   setMaxPriority,   stop,   suspend,   threadStartFailed,   threadTerminated,   toString,   uncaughtException
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.lang.ThreadGroup Detail:
 public int activeCount() 
    Returns an estimate of the number of active threads in this thread group and its subgroups. Recursively iterates over all subgroups in this 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.

 public int activeGroupCount() 
    Returns an estimate of the number of active groups in this thread group and its subgroups. Recursively iterates over all subgroups in this thread group.

    The value returned is only an estimate because the number of thread groups may change dynamically while this method traverses internal data structures. This method is intended primarily for debugging and monitoring purposes.

  void add(Thread t) 
    Adds the specified thread to this thread group.

    Note: This method is called from both library code and the Virtual Machine. It is called from VM to add certain system threads to the system thread group.

  void addUnstarted() 
    Increments the count of unstarted threads in the thread group. Unstarted threads are not added to the thread group so that they can be collected if they are never started, but they must be counted so that daemon thread groups with unstarted threads in them are not destroyed.
 public boolean allowThreadSuspension(boolean b) 
Deprecated! The - definition of this call depends on #suspend , which is deprecated. Further, the behavior of this call was never specified.

    Used by VM to control lowmem implicit suspension.
 public final  void checkAccess() 
    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.

 public final  void destroy() 
    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.

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

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

    {@linkplain #enumerate(Thread[], boolean) enumerate}{@code (list, true)}
 public int enumerate(ThreadGroup[] list) 
    Copies into the specified array references to every active subgroup in this thread group and its subgroups.

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

    {@linkplain #enumerate(ThreadGroup[], boolean) enumerate}{@code (list, true)}
 public int enumerate(Thread[] list,
    boolean recurse) 
    Copies into the specified array every active thread in this thread group. If {@code recurse} is {@code true}, this method recursively enumerates all subgroups of this thread group and references to every active thread in these subgroups are also included. If the array is too short to hold all the threads, the extra threads are silently ignored.

    An application might use the {@linkplain #activeCount 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 {@code list}.

    Due to the inherent race condition in this method, it is recommended that the method only be used for debugging and monitoring purposes.

 public int enumerate(ThreadGroup[] list,
    boolean recurse) 
    Copies into the specified array references to every active subgroup in this thread group. If {@code recurse} is {@code true}, this method recursively enumerates all subgroups of this thread group and references to every active thread group in these subgroups are also included.

    An application might use the {@linkplain #activeGroupCount 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 {@code list}.

    Due to the inherent race condition in this method, it is recommended that the method only be used for debugging and monitoring purposes.

 public final int getMaxPriority() 
    Returns the maximum priority of this thread group. Threads that are part of this group cannot have a higher priority than the maximum priority.
 public final String getName() 
    Returns the name of this thread group.
 public final ThreadGroup getParent() 
    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.

 public final  void interrupt() 
    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.

 public final boolean isDaemon() 
    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.
 public synchronized boolean isDestroyed() 
    Tests if this thread group has been destroyed.
 public  void list() 
    Prints information about this thread group to the standard output. This method is useful only for debugging.
  void list(PrintStream out,
    int indent) 
 public final boolean parentOf(ThreadGroup g) 
    Tests if this thread group is either the thread group argument or one of its ancestor thread groups.
 public final  void resume() 
Deprecated! This - 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.

    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.

 public final  void setDaemon(boolean daemon) 
    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.

 public final  void setMaxPriority(int pri) 
    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.

 public final  void stop() 
Deprecated! This - method is inherently unsafe. See Thread#stop for 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.

 public final  void suspend() 
Deprecated! This - method is inherently deadlock-prone. See Thread#suspend for 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.

  void threadStartFailed(Thread t) 
    Notifies the group that the thread {@code t} has failed an attempt to start.

    The state of this thread group is rolled back as if the attempt to start the thread has never occurred. The thread is again considered an unstarted member of the thread group, and a subsequent attempt to start the thread is permitted.

  void threadTerminated(Thread t) 
    Notifies the group that the thread {@code t} has terminated.

    Destroy the group if all of the following conditions are true: this is a daemon thread group; there are no more alive or unstarted threads in the group; there are no subgroups in this thread group.

 public String toString() 
    Returns a string representation of this Thread group.
 public  void uncaughtException(Thread t,
    Throwable e) 
    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 {@linkplain Thread#getDefaultUncaughtExceptionHandler 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 {@linkplain System#err standard error stream}.

    Applications can override this method in subclasses of ThreadGroup to provide alternative handling of uncaught exceptions.