public interface

ThreadGroupReference

implements ObjectReference
com.sun.jdi.ThreadGroupReference
Known Indirect Subclasses

Class Overview

A thread group object from the target VM. A ThreadGroupReference is an ObjectReference with additional access to threadgroup-specific information from the target VM.

Summary

[Expand]
Inherited Constants
From interface com.sun.jdi.ObjectReference
Public Methods
abstract String name()
Returns the name of this thread group.
abstract ThreadGroupReference parent()
Returns the parent of this thread group.
abstract void resume()
Resumes all threads in this thread group.
abstract void suspend()
Suspends all threads in this thread group.
abstract List<ThreadGroupReference> threadGroups()
Returns a List containing each active ThreadGroupReference in this thread group.
abstract List<ThreadReference> threads()
Returns a List containing a ThreadReference for each live thread in this thread group.
[Expand]
Inherited Methods
From interface com.sun.jdi.Mirror
From interface com.sun.jdi.ObjectReference
From interface com.sun.jdi.Value

Public Methods

public abstract String name ()

Returns the name of this thread group.

Returns
  • the string containing the thread group name.

public abstract ThreadGroupReference parent ()

Returns the parent of this thread group.

Returns
  • a ThreadGroupReference mirroring the parent of this thread group in the target VM, or null if this is a top-level thread group.

public abstract void resume ()

Resumes all threads in this thread group. Each thread in this group and in all of its subgroups will be resumed as described in resume().

Throws
VMCannotBeModifiedException if the VirtualMachine is read-only - see canBeModified().

public abstract void suspend ()

Suspends all threads in this thread group. Each thread in this group and in all of its subgroups will be suspended as described in suspend(). This is not guaranteed to be an atomic operation; if the target VM is not interrupted at the time this method is called, it is possible that new threads will be created between the time that threads are enumerated and all of them have been suspended.

Throws
VMCannotBeModifiedException if the VirtualMachine is read-only - see canBeModified().

public abstract List<ThreadGroupReference> threadGroups ()

Returns a List containing each active ThreadGroupReference in this thread group. Only the active thread groups in this immediate thread group (and not its subgroups) are returned. See java.lang.ThreadGroup for information about 'active' ThreadGroups.

Returns
  • a List of ThreadGroupReference objects mirroring the active thread groups from this thread group in the target VM.

public abstract List<ThreadReference> threads ()

Returns a List containing a ThreadReference for each live thread in this thread group. Only the live threads in this immediate thread group (and not its subgroups) are returned. A thread is alive if it has been started and has not yet been stopped.

Returns
  • a List of ThreadReference objects mirroring the live threads from this thread group in the target VM.