- All Superinterfaces:
Mirror
,ObjectReference
,Value
public interface ThreadGroupReference extends ObjectReference
A thread group object from the target VM.
A ThreadGroupReference is an
ObjectReference
with additional
access to threadgroup-specific information from the target VM.- Since:
- 1.3
-
Field Summary
Fields declared in interface com.sun.jdi.ObjectReference
INVOKE_NONVIRTUAL, INVOKE_SINGLE_THREADED
-
Method Summary
Modifier and Type Method Description String
name()
Returns the name of this thread group.ThreadGroupReference
parent()
Returns the parent of this thread group.void
resume()
Resumes all threads in this thread group.void
suspend()
Suspends all threads in this thread group.List<ThreadGroupReference>
threadGroups()
Returns a List containing each activeThreadGroupReference
in this thread group.List<ThreadReference>
threads()
Returns a List containing aThreadReference
for each live thread in this thread group.Methods declared in interface com.sun.jdi.Mirror
toString, virtualMachine
Methods declared in interface com.sun.jdi.ObjectReference
disableCollection, enableCollection, entryCount, equals, getValue, getValues, hashCode, invokeMethod, isCollected, owningThread, referenceType, referringObjects, setValue, uniqueID, waitingThreads
-
Method Details
-
name
String name()Returns the name of this thread group.- Returns:
- the string containing the thread group name.
-
parent
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.
-
suspend
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 inThreadReference.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 - seeVirtualMachine.canBeModified()
.
-
resume
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 inThreadReference.resume()
.- Throws:
VMCannotBeModifiedException
- if the VirtualMachine is read-only - seeVirtualMachine.canBeModified()
.
-
threads
List<ThreadReference> threads()Returns a List containing aThreadReference
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.
-
threadGroups
List<ThreadGroupReference> threadGroups()Returns a List containing each activeThreadGroupReference
in this thread group. Only the active thread groups in this immediate thread group (and not its subgroups) are returned. SeeThreadGroup
for information about 'active' ThreadGroups.- Returns:
- a List of
ThreadGroupReference
objects mirroring the active thread groups from this thread group in the target VM.
-