APIdia Launch Partner
Top Description Fields Methods
com.sun.jdi

public Interface ThreadGroupReference

extends ObjectReference
Known Direct Implementers
com.sun.tools.jdi.ThreadGroupReferenceImpl
Imports
java.util.List
A thread group object from the target VM. A ThreadGroupReference is an ObjectReference with additional access to threadgroup-specific information from the target VM.
Authors
Robert Field, Gordon Hirsch, James McIlree
Since
1.3

Field Summary

Inherited from com.sun.jdi.ObjectReference:
INVOKE_NONVIRTUALINVOKE_SINGLE_THREADED

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the string containing the thread group name.
name()

Returns the name of this thread group.

public ThreadGroupReference

Returns:

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

Returns the parent of this thread group.

public void
resume()

Resumes all threads in this thread group.

public void
suspend()

Suspends all threads in this thread group.

public List<ThreadGroupReference>

Returns:

a List of ThreadGroupReference objects mirroring the thread groups from this thread group in the target VM.
threadGroups()

Returns a List containing a ThreadGroupReference for each subgroup.

public List<ThreadReference>

Returns:

a List of ThreadReference objects mirroring the live platform threads from this thread group in the target VM.
threads()

Returns a List containing a ThreadReference for each live platform thread in this thread group.

Inherited from com.sun.jdi.ObjectReference:
disableCollectionenableCollectionentryCountequalsgetValuegetValueshashCodeinvokeMethodisCollectedowningThreadreferenceTypereferringObjectssetValueuniqueIDwaitingThreads

Method Detail

nameback to summary
public String name()

Returns the name of this thread group.

Returns:String

the string containing the thread group name.

parentback to summary
public ThreadGroupReference parent()

Returns the parent of this thread group.

Returns:ThreadGroupReference

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

resumeback to summary
public 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 ThreadReference#resume.

Exceptions
VMCannotBeModifiedException:
if the VirtualMachine is read-only - see VirtualMachine#canBeModified().
suspendback to summary
public 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 ThreadReference#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.

Exceptions
VMCannotBeModifiedException:
if the VirtualMachine is read-only - see VirtualMachine#canBeModified().
threadGroupsback to summary
public List<ThreadGroupReference> threadGroups()

Returns a List containing a ThreadGroupReference for each subgroup. Only the thread groups in this immediate thread group (and not its subgroups) are returned.

Returns:List<ThreadGroupReference>

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

threadsback to summary
public List<ThreadReference> threads()

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

Returns:List<ThreadReference>

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