com.sun.jdi
Interface ThreadGroupReference

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

Fields inherited from interface com.sun.jdi.ObjectReference

INVOKE_NONVIRTUAL, INVOKE_SINGLE_THREADED

Method Summary

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	threadGroups() Returns a List containing each ThreadGroupReference in this thread group.
List	threads() Returns a List containing each ThreadReference in this thread group.

Methods inherited from interface com.sun.jdi.ObjectReference

disableCollection, enableCollection, entryCount, equals, getValue, getValues, hashCode, invokeMethod, isCollected, owningThread, referenceType, setValue, uniqueID, waitingThreads

Methods inherited from interface com.sun.jdi.Value

type

Methods inherited from interface com.sun.jdi.Mirror

toString, virtualMachine

Method Detail

name

public String name()

Returns the name of this thread group.

Returns:

the string containing the thread group name.

Throws:

ObjectCollectedException - if this object has been garbage collected.

parent

public 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.

Throws:

ObjectCollectedException - if this object has been garbage collected.

suspend

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.

Throws:

ObjectCollectedException - if this object has been garbage collected.

resume

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().

Throws:

ObjectCollectedException - if this object has been garbage collected.

threads

public List threads()

Returns a List containing each ThreadReference in this thread group. Only the threads in this immediate thread group (and not its subgroups) are returned.

Returns:

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

Throws:

ObjectCollectedException - if this object has been garbage collected.

threadGroups

public List threadGroups()

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

Returns:

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

Throws:

ObjectCollectedException - if this object has been garbage collected.