Class ExtendedHotSpotDiagnostic
java.lang.Object
com.sun.management.internal.ExtendedHotSpotDiagnostic
- All Implemented Interfaces:
HotSpotDiagnosticMXBean, PlatformManagedObject
Runtime type for
HotSpotDiagnosticMXBean
.-
Nested Class Summary
Nested classes/interfaces declared in interface HotSpotDiagnosticMXBean
HotSpotDiagnosticMXBean.ThreadDumpFormat
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Dumps the heap to theoutputFile
file in the same format as the hprof heap dump.void
dumpThreads
(String outputFile, HotSpotDiagnosticMXBean.ThreadDumpFormat format) Generate a thread dump to the given file in the given format.Returns a list ofVMOption
objects for all diagnostic options.static HotSpotDiagnosticMXBean
Singleton accessor method.Returns anObjectName
instance representing the object name of this platform managed object.getVMOption
(String name) Returns aVMOption
object for a VM option of the given name.void
setVMOption
(String name, String value) Sets a VM option of the given name to the specified value.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface HotSpotDiagnosticMXBean
dumpThreads
Methods declared in interface PlatformManagedObject
getObjectName
-
Method Details
-
getInstance
Singleton accessor method.- Returns:
- the
HotSpotDiagnostic
singleton.
-
dumpHeap
Dumps the heap to theoutputFile
file in the same format as the hprof heap dump.If this method is called remotely from another process, the heap dump output is written to a file named
outputFile
on the machine where the target VM is running. If outputFile is a relative path, it is relative to the working directory where the target VM was started.- Specified by:
dumpHeap
in interfaceHotSpotDiagnosticMXBean
- Parameters:
outputFile
- the system-dependent filenamelive
- iftrue
dump only live objects i.e. objects that are reachable from others- Throws:
IOException
- if theoutputFile
already exists, cannot be created, opened, or written to.
-
getDiagnosticOptions
Returns a list ofVMOption
objects for all diagnostic options. A diagnostic option is awriteable
VM option that can be set dynamically mainly for troubleshooting and diagnosis.- Specified by:
getDiagnosticOptions
in interfaceHotSpotDiagnosticMXBean
- Returns:
- a list of
VMOption
objects for all diagnostic options.
-
getVMOption
Returns aVMOption
object for a VM option of the given name.- Specified by:
getVMOption
in interfaceHotSpotDiagnosticMXBean
- Returns:
- a
VMOption
object for a VM option of the given name.
-
setVMOption
Sets a VM option of the given name to the specified value. The new value will be reflected in a newVMOption
object returned by theHotSpotDiagnosticMXBean.getVMOption(String)
method or theHotSpotDiagnosticMXBean.getDiagnosticOptions()
method. This method does not change the value of thisVMOption
object.- Specified by:
setVMOption
in interfaceHotSpotDiagnosticMXBean
- Parameters:
name
- Name of a VM optionvalue
- New value of the VM option to be set
-
getObjectName
Description copied from interface:java.lang.management.PlatformManagedObject
Returns anObjectName
instance representing the object name of this platform managed object.- Specified by:
getObjectName
in interfacePlatformManagedObject
- Returns:
- an
ObjectName
instance representing the object name of this platform managed object.
-
dumpThreads
public void dumpThreads(String outputFile, HotSpotDiagnosticMXBean.ThreadDumpFormat format) throws IOException Description copied from interface:com.sun.management.HotSpotDiagnosticMXBean
Generate a thread dump to the given file in the given format. TheoutputFile
parameter must be an absolute path to a file that does not exist.When the format is specified as
JSON
, the thread dump is generated in JavaScript Object Notation. threadDump.schema.json describes the thread dump format in draft JSON Schema Language version 2.The thread dump will include output for all platform threads. It may include output for some or all virtual threads.
- Specified by:
dumpThreads
in interfaceHotSpotDiagnosticMXBean
- Parameters:
outputFile
- the path to the file to createformat
- the format to use- Throws:
IOException
- if the file already exists or an I/O exception is thrown writing to the file
-