-
- All Superinterfaces:
PlatformManagedObject
public interface ThreadMXBean extends PlatformManagedObject
The management interface for the thread system of the Java virtual machine.A Java virtual machine has a single instance of the implementation class of this interface. This instance implementing this interface is an MXBean that can be obtained by calling the
ManagementFactory.getThreadMXBean()
method or from theplatform MBeanServer
method.The
ObjectName
for uniquely identifying the MXBean for the thread system within an MBeanServer is:java.lang:type=Threading
PlatformManagedObject.getObjectName()
method.Thread ID
Thread ID is a positive long value returned by calling theThread.getId()
method for a thread. The thread ID is unique during its lifetime. When a thread is terminated, this thread ID may be reused.Some methods in this interface take a thread ID or an array of thread IDs as the input parameter and return per-thread information.
Thread CPU time
A Java virtual machine implementation may support measuring the CPU time for the current thread, for any thread, or for no threads.The
isThreadCpuTimeSupported()
method can be used to determine if a Java virtual machine supports measuring of the CPU time for any thread. TheisCurrentThreadCpuTimeSupported()
method can be used to determine if a Java virtual machine supports measuring of the CPU time for the current thread. A Java virtual machine implementation that supports CPU time measurement for any thread will also support that for the current thread.The CPU time provided by this interface has nanosecond precision but not necessarily nanosecond accuracy.
A Java virtual machine may disable CPU time measurement by default. The
isThreadCpuTimeEnabled()
andsetThreadCpuTimeEnabled(boolean)
methods can be used to test if CPU time measurement is enabled and to enable/disable this support respectively. Enabling thread CPU measurement could be expensive in some Java virtual machine implementations.Thread Contention Monitoring
Some Java virtual machines may support thread contention monitoring. When thread contention monitoring is enabled, the accumulated elapsed time that the thread has blocked for synchronization or waited for notification will be collected and returned in theThreadInfo
object.The
isThreadContentionMonitoringSupported()
method can be used to determine if a Java virtual machine supports thread contention monitoring. The thread contention monitoring is disabled by default. ThesetThreadContentionMonitoringEnabled(boolean)
method can be used to enable thread contention monitoring.Synchronization Information and Deadlock Detection
Some Java virtual machines may support monitoring of object monitor usage and ownable synchronizer usage. ThegetThreadInfo(long[], boolean, boolean)
anddumpAllThreads(boolean, boolean)
methods can be used to obtain the thread stack trace and synchronization information including which lock a thread is blocked to acquire or waiting on and which locks the thread currently owns.The
ThreadMXBean
interface provides thefindMonitorDeadlockedThreads()
andfindDeadlockedThreads()
methods to find deadlocks in the running application.- Since:
- 1.5
- See Also:
ManagementFactory.getPlatformMXBeans(Class)
, JMX Specification., Ways to Access MXBeans
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ThreadInfo[]
dumpAllThreads(boolean lockedMonitors, boolean lockedSynchronizers)
Returns the thread info for all live threads with stack trace and synchronization information.default ThreadInfo[]
dumpAllThreads(boolean lockedMonitors, boolean lockedSynchronizers, int maxDepth)
Returns the thread info for all live threads with stack trace of the specified maximum number of elements and synchronization information.long[]
findDeadlockedThreads()
Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.long[]
findMonitorDeadlockedThreads()
Finds cycles of threads that are in deadlock waiting to acquire object monitors.long[]
getAllThreadIds()
Returns all live thread IDs.long
getCurrentThreadCpuTime()
Returns the total CPU time for the current thread in nanoseconds.long
getCurrentThreadUserTime()
Returns the CPU time that the current thread has executed in user mode in nanoseconds.int
getDaemonThreadCount()
Returns the current number of live daemon threads.int
getPeakThreadCount()
Returns the peak live thread count since the Java virtual machine started or peak was reset.int
getThreadCount()
Returns the current number of live threads including both daemon and non-daemon threads.long
getThreadCpuTime(long id)
Returns the total CPU time for a thread of the specified ID in nanoseconds.ThreadInfo
getThreadInfo(long id)
Returns the thread info for a thread of the specifiedid
with no stack trace.ThreadInfo[]
getThreadInfo(long[] ids)
Returns the thread info for each thread whose ID is in the input arrayids
with no stack trace.ThreadInfo[]
getThreadInfo(long[] ids, boolean lockedMonitors, boolean lockedSynchronizers)
Returns the thread info for each thread whose ID is in the input arrayids
, with stack trace and synchronization information.default ThreadInfo[]
getThreadInfo(long[] ids, boolean lockedMonitors, boolean lockedSynchronizers, int maxDepth)
Returns the thread info for each thread whose ID is in the input arrayids
, with stack trace of the specified maximum number of elements and synchronization information.ThreadInfo[]
getThreadInfo(long[] ids, int maxDepth)
Returns the thread info for each thread whose ID is in the input arrayids
, with stack trace of a specified number of stack trace elements.ThreadInfo
getThreadInfo(long id, int maxDepth)
Returns a thread info for a thread of the specifiedid
, with stack trace of a specified number of stack trace elements.long
getThreadUserTime(long id)
Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.long
getTotalStartedThreadCount()
Returns the total number of threads created and also started since the Java virtual machine started.boolean
isCurrentThreadCpuTimeSupported()
Tests if the Java virtual machine supports CPU time measurement for the current thread.boolean
isObjectMonitorUsageSupported()
Tests if the Java virtual machine supports monitoring of object monitor usage.boolean
isSynchronizerUsageSupported()
Tests if the Java virtual machine supports monitoring of ownable synchronizer usage.boolean
isThreadContentionMonitoringEnabled()
Tests if thread contention monitoring is enabled.boolean
isThreadContentionMonitoringSupported()
Tests if the Java virtual machine supports thread contention monitoring.boolean
isThreadCpuTimeEnabled()
Tests if thread CPU time measurement is enabled.boolean
isThreadCpuTimeSupported()
Tests if the Java virtual machine implementation supports CPU time measurement for any thread.void
resetPeakThreadCount()
Resets the peak thread count to the current number of live threads.void
setThreadContentionMonitoringEnabled(boolean enable)
Enables or disables thread contention monitoring.void
setThreadCpuTimeEnabled(boolean enable)
Enables or disables thread CPU time measurement.-
Methods declared in interface java.lang.management.PlatformManagedObject
getObjectName
-
-
-
-
Method Detail
-
getThreadCount
int getThreadCount()
Returns the current number of live threads including both daemon and non-daemon threads.- Returns:
- the current number of live threads.
-
getPeakThreadCount
int getPeakThreadCount()
Returns the peak live thread count since the Java virtual machine started or peak was reset.- Returns:
- the peak live thread count.
-
getTotalStartedThreadCount
long getTotalStartedThreadCount()
Returns the total number of threads created and also started since the Java virtual machine started.- Returns:
- the total number of threads started.
-
getDaemonThreadCount
int getDaemonThreadCount()
Returns the current number of live daemon threads.- Returns:
- the current number of live daemon threads.
-
getAllThreadIds
long[] getAllThreadIds()
Returns all live thread IDs. Some threads included in the returned array may have been terminated when this method returns.- Returns:
- an array of
long
, each is a thread ID. - Throws:
SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").
-
getThreadInfo
ThreadInfo getThreadInfo(long id)
Returns the thread info for a thread of the specifiedid
with no stack trace. This method is equivalent to calling:getThreadInfo(id, 0);
This method returns a
ThreadInfo
object representing the thread information for the thread of the specified ID. The stack trace, locked monitors, and locked synchronizers in the returnedThreadInfo
object will be empty. If a thread of the given ID is not alive or does not exist, this method will returnnull
. A thread is alive if it has been started and has not yet died.MBeanServer access:
The mapped type ofThreadInfo
isCompositeData
with attributes as specified in theThreadInfo.from
method.- Parameters:
id
- the thread ID of the thread. Must be positive.- Returns:
- a
ThreadInfo
object for the thread of the given ID with no stack trace, no locked monitor and no synchronizer info;null
if the thread of the given ID is not alive or it does not exist. - Throws:
IllegalArgumentException
- ifid <= 0
.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").
-
getThreadInfo
ThreadInfo[] getThreadInfo(long[] ids)
Returns the thread info for each thread whose ID is in the input arrayids
with no stack trace. This method is equivalent to calling:getThreadInfo
(ids, 0);This method returns an array of the
ThreadInfo
objects. The stack trace, locked monitors, and locked synchronizers in eachThreadInfo
object will be empty. If a thread of a given ID is not alive or does not exist, the corresponding element in the returned array will containnull
. A thread is alive if it has been started and has not yet died.MBeanServer access:
The mapped type ofThreadInfo
isCompositeData
with attributes as specified in theThreadInfo.from
method.- Parameters:
ids
- an array of thread IDs.- Returns:
- an array of the
ThreadInfo
objects, each containing information about a thread whose ID is in the corresponding element of the input array of IDs with no stack trace, no locked monitor and no synchronizer info. - Throws:
IllegalArgumentException
- if any element in the input arrayids
is<= 0
.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").
-
getThreadInfo
ThreadInfo getThreadInfo(long id, int maxDepth)
Returns a thread info for a thread of the specifiedid
, with stack trace of a specified number of stack trace elements. ThemaxDepth
parameter indicates the maximum number ofStackTraceElement
to be retrieved from the stack trace. IfmaxDepth == Integer.MAX_VALUE
, the entire stack trace of the thread will be dumped. IfmaxDepth == 0
, no stack trace of the thread will be dumped. This method does not obtain the locked monitors and locked synchronizers of the thread.When the Java virtual machine has no stack trace information about a thread or
maxDepth == 0
, the stack trace in theThreadInfo
object will be an empty array ofStackTraceElement
.If a thread of the given ID is not alive or does not exist, this method will return
null
. A thread is alive if it has been started and has not yet died.MBeanServer access:
The mapped type ofThreadInfo
isCompositeData
with attributes as specified in theThreadInfo.from
method.- Parameters:
id
- the thread ID of the thread. Must be positive.maxDepth
- the maximum number of entries in the stack trace to be dumped.Integer.MAX_VALUE
could be used to request the entire stack to be dumped.- Returns:
- a
ThreadInfo
of the thread of the given ID with no locked monitor and synchronizer info.null
if the thread of the given ID is not alive or it does not exist. - Throws:
IllegalArgumentException
- ifid <= 0
.IllegalArgumentException
- ifmaxDepth is negative
.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").
-
getThreadInfo
ThreadInfo[] getThreadInfo(long[] ids, int maxDepth)
Returns the thread info for each thread whose ID is in the input arrayids
, with stack trace of a specified number of stack trace elements. ThemaxDepth
parameter indicates the maximum number ofStackTraceElement
to be retrieved from the stack trace. IfmaxDepth == Integer.MAX_VALUE
, the entire stack trace of the thread will be dumped. IfmaxDepth == 0
, no stack trace of the thread will be dumped. This method does not obtain the locked monitors and locked synchronizers of the threads.When the Java virtual machine has no stack trace information about a thread or
maxDepth == 0
, the stack trace in theThreadInfo
object will be an empty array ofStackTraceElement
.This method returns an array of the
ThreadInfo
objects, each is the thread information about the thread with the same index as in theids
array. If a thread of the given ID is not alive or does not exist,null
will be set in the corresponding element in the returned array. A thread is alive if it has been started and has not yet died.MBeanServer access:
The mapped type ofThreadInfo
isCompositeData
with attributes as specified in theThreadInfo.from
method.- Parameters:
ids
- an array of thread IDsmaxDepth
- the maximum number of entries in the stack trace to be dumped.Integer.MAX_VALUE
could be used to request the entire stack to be dumped.- Returns:
- an array of the
ThreadInfo
objects, each containing information about a thread whose ID is in the corresponding element of the input array of IDs with no locked monitor and synchronizer info. - Throws:
IllegalArgumentException
- ifmaxDepth is negative
.IllegalArgumentException
- if any element in the input arrayids
is<= 0
.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").
-
isThreadContentionMonitoringSupported
boolean isThreadContentionMonitoringSupported()
Tests if the Java virtual machine supports thread contention monitoring.- Returns:
true
if the Java virtual machine supports thread contention monitoring;false
otherwise.
-
isThreadContentionMonitoringEnabled
boolean isThreadContentionMonitoringEnabled()
Tests if thread contention monitoring is enabled.- Returns:
true
if thread contention monitoring is enabled;false
otherwise.- Throws:
UnsupportedOperationException
- if the Java virtual machine does not support thread contention monitoring.- See Also:
isThreadContentionMonitoringSupported()
-
setThreadContentionMonitoringEnabled
void setThreadContentionMonitoringEnabled(boolean enable)
Enables or disables thread contention monitoring. Thread contention monitoring is disabled by default.- Parameters:
enable
-true
to enable;false
to disable.- Throws:
UnsupportedOperationException
- if the Java virtual machine does not support thread contention monitoring.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("control").- See Also:
isThreadContentionMonitoringSupported()
-
getCurrentThreadCpuTime
long getCurrentThreadCpuTime()
Returns the total CPU time for the current thread in nanoseconds. The returned value is of nanoseconds precision but not necessarily nanoseconds accuracy. If the implementation distinguishes between user mode time and system mode time, the returned CPU time is the amount of time that the current thread has executed in user mode or system mode.This is a convenient method for local management use and is equivalent to calling:
getThreadCpuTime
(Thread.currentThread().getId());- Returns:
- the total CPU time for the current thread if CPU time
measurement is enabled;
-1
otherwise. - Throws:
UnsupportedOperationException
- if the Java virtual machine does not support CPU time measurement for the current thread.- See Also:
getCurrentThreadUserTime()
,isCurrentThreadCpuTimeSupported()
,isThreadCpuTimeEnabled()
,setThreadCpuTimeEnabled(boolean)
-
getCurrentThreadUserTime
long getCurrentThreadUserTime()
Returns the CPU time that the current thread has executed in user mode in nanoseconds. The returned value is of nanoseconds precision but not necessarily nanoseconds accuracy.This is a convenient method for local management use and is equivalent to calling:
getThreadUserTime
(Thread.currentThread().getId());- Returns:
- the user-level CPU time for the current thread if CPU time
measurement is enabled;
-1
otherwise. - Throws:
UnsupportedOperationException
- if the Java virtual machine does not support CPU time measurement for the current thread.- See Also:
getCurrentThreadCpuTime()
,isCurrentThreadCpuTimeSupported()
,isThreadCpuTimeEnabled()
,setThreadCpuTimeEnabled(boolean)
-
getThreadCpuTime
long getThreadCpuTime(long id)
Returns the total CPU time for a thread of the specified ID in nanoseconds. The returned value is of nanoseconds precision but not necessarily nanoseconds accuracy. If the implementation distinguishes between user mode time and system mode time, the returned CPU time is the amount of time that the thread has executed in user mode or system mode.If the thread of the specified ID is not alive or does not exist, this method returns
-1
. If CPU time measurement is disabled, this method returns-1
. A thread is alive if it has been started and has not yet died.If CPU time measurement is enabled after the thread has started, the Java virtual machine implementation may choose any time up to and including the time that the capability is enabled as the point where CPU time measurement starts.
- Parameters:
id
- the thread ID of a thread- Returns:
- the total CPU time for a thread of the specified ID
if the thread of the specified ID exists, the thread is alive,
and CPU time measurement is enabled;
-1
otherwise. - Throws:
IllegalArgumentException
- ifid <= 0
.UnsupportedOperationException
- if the Java virtual machine does not support CPU time measurement for other threads.- See Also:
getThreadUserTime(long)
,isThreadCpuTimeSupported()
,isThreadCpuTimeEnabled()
,setThreadCpuTimeEnabled(boolean)
-
getThreadUserTime
long getThreadUserTime(long id)
Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds. The returned value is of nanoseconds precision but not necessarily nanoseconds accuracy.If the thread of the specified ID is not alive or does not exist, this method returns
-1
. If CPU time measurement is disabled, this method returns-1
. A thread is alive if it has been started and has not yet died.If CPU time measurement is enabled after the thread has started, the Java virtual machine implementation may choose any time up to and including the time that the capability is enabled as the point where CPU time measurement starts.
- Parameters:
id
- the thread ID of a thread- Returns:
- the user-level CPU time for a thread of the specified ID
if the thread of the specified ID exists, the thread is alive,
and CPU time measurement is enabled;
-1
otherwise. - Throws:
IllegalArgumentException
- ifid <= 0
.UnsupportedOperationException
- if the Java virtual machine does not support CPU time measurement for other threads.- See Also:
getThreadCpuTime(long)
,isThreadCpuTimeSupported()
,isThreadCpuTimeEnabled()
,setThreadCpuTimeEnabled(boolean)
-
isThreadCpuTimeSupported
boolean isThreadCpuTimeSupported()
Tests if the Java virtual machine implementation supports CPU time measurement for any thread. A Java virtual machine implementation that supports CPU time measurement for any thread will also support CPU time measurement for the current thread.- Returns:
true
if the Java virtual machine supports CPU time measurement for any thread;false
otherwise.
-
isCurrentThreadCpuTimeSupported
boolean isCurrentThreadCpuTimeSupported()
Tests if the Java virtual machine supports CPU time measurement for the current thread. This method returnstrue
ifisThreadCpuTimeSupported()
returnstrue
.- Returns:
true
if the Java virtual machine supports CPU time measurement for current thread;false
otherwise.
-
isThreadCpuTimeEnabled
boolean isThreadCpuTimeEnabled()
Tests if thread CPU time measurement is enabled.- Returns:
true
if thread CPU time measurement is enabled;false
otherwise.- Throws:
UnsupportedOperationException
- if the Java virtual machine does not support CPU time measurement for other threads nor for the current thread.- See Also:
isThreadCpuTimeSupported()
,isCurrentThreadCpuTimeSupported()
-
setThreadCpuTimeEnabled
void setThreadCpuTimeEnabled(boolean enable)
Enables or disables thread CPU time measurement. The default is platform dependent.- Parameters:
enable
-true
to enable;false
to disable.- Throws:
UnsupportedOperationException
- if the Java virtual machine does not support CPU time measurement for any threads nor for the current thread.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("control").- See Also:
isThreadCpuTimeSupported()
,isCurrentThreadCpuTimeSupported()
-
findMonitorDeadlockedThreads
long[] findMonitorDeadlockedThreads()
Finds cycles of threads that are in deadlock waiting to acquire object monitors. That is, threads that are blocked waiting to enter a synchronization block or waiting to reenter a synchronization block after anObject.wait
call, where each thread owns one monitor while trying to obtain another monitor already held by another thread in a cycle.More formally, a thread is monitor deadlocked if it is part of a cycle in the relation "is waiting for an object monitor owned by". In the simplest case, thread A is blocked waiting for a monitor owned by thread B, and thread B is blocked waiting for a monitor owned by thread A.
This method is designed for troubleshooting use, but not for synchronization control. It might be an expensive operation.
This method finds deadlocks involving only object monitors. To find deadlocks involving both object monitors and ownable synchronizers, the
findDeadlockedThreads
method should be used.- Returns:
- an array of IDs of the threads that are monitor
deadlocked, if any;
null
otherwise. - Throws:
SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").- See Also:
findDeadlockedThreads()
-
resetPeakThreadCount
void resetPeakThreadCount()
Resets the peak thread count to the current number of live threads.- Throws:
SecurityException
- if a security manager exists and the caller does not have ManagementPermission("control").- See Also:
getPeakThreadCount()
,getThreadCount()
-
findDeadlockedThreads
long[] findDeadlockedThreads()
Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. Threads are deadlocked in a cycle waiting for a lock of these two types if each thread owns one lock while trying to acquire another lock already held by another thread in the cycle.This method is designed for troubleshooting use, but not for synchronization control. It might be an expensive operation.
- Returns:
- an array of IDs of the threads that are
deadlocked waiting for object monitors or ownable synchronizers, if any;
null
otherwise. - Throws:
SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").UnsupportedOperationException
- if the Java virtual machine does not support monitoring of ownable synchronizer usage.- Since:
- 1.6
- See Also:
isSynchronizerUsageSupported()
,findMonitorDeadlockedThreads()
-
isObjectMonitorUsageSupported
boolean isObjectMonitorUsageSupported()
Tests if the Java virtual machine supports monitoring of object monitor usage.- Returns:
true
if the Java virtual machine supports monitoring of object monitor usage;false
otherwise.- Since:
- 1.6
- See Also:
dumpAllThreads(boolean, boolean)
-
isSynchronizerUsageSupported
boolean isSynchronizerUsageSupported()
Tests if the Java virtual machine supports monitoring of ownable synchronizer usage.- Returns:
true
if the Java virtual machine supports monitoring of ownable synchronizer usage;false
otherwise.- Since:
- 1.6
- See Also:
dumpAllThreads(boolean, boolean)
-
getThreadInfo
ThreadInfo[] getThreadInfo(long[] ids, boolean lockedMonitors, boolean lockedSynchronizers)
Returns the thread info for each thread whose ID is in the input arrayids
, with stack trace and synchronization information. This is equivalent to calling:getThreadInfo(ids, lockedMonitors, lockedSynchronizers, Integer.MAX_VALUE)
- Parameters:
ids
- an array of thread IDs.lockedMonitors
- iftrue
, retrieves all locked monitors.lockedSynchronizers
- iftrue
, retrieves all locked ownable synchronizers.- Returns:
- an array of the
ThreadInfo
objects, each containing information about a thread whose ID is in the corresponding element of the input array of IDs. - Throws:
SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").UnsupportedOperationException
-- if
lockedMonitors
istrue
but the Java virtual machine does not support monitoring of object monitor usage; or - if
lockedSynchronizers
istrue
but the Java virtual machine does not support monitoring of ownable synchronizer usage.
- if
- Since:
- 1.6
- See Also:
isObjectMonitorUsageSupported()
,isSynchronizerUsageSupported()
-
getThreadInfo
default ThreadInfo[] getThreadInfo(long[] ids, boolean lockedMonitors, boolean lockedSynchronizers, int maxDepth)
Returns the thread info for each thread whose ID is in the input arrayids
, with stack trace of the specified maximum number of elements and synchronization information. IfmaxDepth == 0
, no stack trace of the thread will be dumped.This method obtains a snapshot of the thread information for each thread including:
- stack trace of the specified maximum number of elements,
- the object monitors currently locked by the thread
if
lockedMonitors
istrue
, and - the
ownable synchronizers currently locked by the thread
if
lockedSynchronizers
istrue
.
This method returns an array of the
ThreadInfo
objects, each is the thread information about the thread with the same index as in theids
array. If a thread of the given ID is not alive or does not exist,null
will be set in the corresponding element in the returned array. A thread is alive if it has been started and has not yet died.If a thread does not lock any object monitor or
lockedMonitors
isfalse
, the returnedThreadInfo
object will have an emptyMonitorInfo
array. Similarly, if a thread does not lock any synchronizer orlockedSynchronizers
isfalse
, the returnedThreadInfo
object will have an emptyLockInfo
array.When both
lockedMonitors
andlockedSynchronizers
parameters arefalse
, it is equivalent to calling:getThreadInfo(ids, maxDepth)
This method is designed for troubleshooting use, but not for synchronization control. It might be an expensive operation.
MBeanServer access:
The mapped type ofThreadInfo
isCompositeData
with attributes as specified in theThreadInfo.from
method.- Implementation Requirements:
- The default implementation throws
UnsupportedOperationException
. - Parameters:
ids
- an array of thread IDs.lockedMonitors
- iftrue
, retrieves all locked monitors.lockedSynchronizers
- iftrue
, retrieves all locked ownable synchronizers.maxDepth
- indicates the maximum number ofStackTraceElement
to be retrieved from the stack trace.- Returns:
- an array of the
ThreadInfo
objects, each containing information about a thread whose ID is in the corresponding element of the input array of IDs. - Throws:
IllegalArgumentException
- ifmaxDepth
is negative.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").UnsupportedOperationException
-- if
lockedMonitors
istrue
but the Java virtual machine does not support monitoring of object monitor usage; or - if
lockedSynchronizers
istrue
but the Java virtual machine does not support monitoring of ownable synchronizer usage.
- if
- Since:
- 10
- See Also:
isObjectMonitorUsageSupported()
,isSynchronizerUsageSupported()
-
dumpAllThreads
ThreadInfo[] dumpAllThreads(boolean lockedMonitors, boolean lockedSynchronizers)
Returns the thread info for all live threads with stack trace and synchronization information. This is equivalent to calling:dumpAllThreads(lockedMonitors, lockedSynchronizers, Integer.MAX_VALUE)
- Parameters:
lockedMonitors
- iftrue
, dump all locked monitors.lockedSynchronizers
- iftrue
, dump all locked ownable synchronizers.- Returns:
- an array of
ThreadInfo
for all live threads. - Throws:
SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").UnsupportedOperationException
-- if
lockedMonitors
istrue
but the Java virtual machine does not support monitoring of object monitor usage; or - if
lockedSynchronizers
istrue
but the Java virtual machine does not support monitoring of ownable synchronizer usage.
- if
- Since:
- 1.6
- See Also:
isObjectMonitorUsageSupported()
,isSynchronizerUsageSupported()
-
dumpAllThreads
default ThreadInfo[] dumpAllThreads(boolean lockedMonitors, boolean lockedSynchronizers, int maxDepth)
Returns the thread info for all live threads with stack trace of the specified maximum number of elements and synchronization information. ifmaxDepth == 0
, no stack trace of the thread will be dumped. Some threads included in the returned array may have been terminated when this method returns.This method returns an array of
ThreadInfo
objects as specified in thegetThreadInfo(long[], boolean, boolean, int)
method.- Implementation Requirements:
- The default implementation throws
UnsupportedOperationException
. - Parameters:
lockedMonitors
- iftrue
, dump all locked monitors.lockedSynchronizers
- iftrue
, dump all locked ownable synchronizers.maxDepth
- indicates the maximum number ofStackTraceElement
to be retrieved from the stack trace.- Returns:
- an array of
ThreadInfo
for all live threads. - Throws:
IllegalArgumentException
- ifmaxDepth
is negative.SecurityException
- if a security manager exists and the caller does not have ManagementPermission("monitor").UnsupportedOperationException
-- if
lockedMonitors
istrue
but the Java virtual machine does not support monitoring of object monitor usage; or - if
lockedSynchronizers
istrue
but the Java virtual machine does not support monitoring of ownable synchronizer usage.
- if
- Since:
- 10
- See Also:
isObjectMonitorUsageSupported()
,isSynchronizerUsageSupported()
-
-