public interface

HotSpotDiagnosticMXBean

com.sun.management.HotSpotDiagnosticMXBean
Known Indirect Subclasses

Class Overview

Diagnostic management interface for the HotSpot Virtual Machine. The diagnostic MBean is registered to the platform MBeanServer as are other platform MBeans.

The ObjectName for uniquely identifying the diagnostic MXBean within an MBeanServer is:

com.sun.management:type=HotSpotDiagnostic

Summary

Public Methods
abstract void dumpHeap(String outputFile, boolean live)
Dumps the heap to the outputFile file in the same format as the hprof heap dump.
abstract List<VMOption> getDiagnosticOptions()
Returns a list of VMOption objects for all diagnostic options.
abstract VMOption getVMOption(String name)
Returns a VMOption object for a VM option of the given name.
abstract void setVMOption(String name, String value)
Sets a VM option of the given name to the specified value.

Public Methods

public abstract void dumpHeap (String outputFile, boolean live)

Dumps the heap to the outputFile 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.

Parameters
outputFile the system-dependent filename
live if true dump only live objects i.e. objects that are reachable from others
Throws
if the outputFile cannot be created, opened, or written to.
UnsupportedOperationException if this operation is not supported.
NullPointerException if outputFile is null.
IOException

public abstract List<VMOption> getDiagnosticOptions ()

Returns a list of VMOption objects for all diagnostic options. A diagnostic option is a writeable VM option that can be set dynamically mainly for troubleshooting and diagnosis.

Returns
  • a list of VMOption objects for all diagnostic options.

public abstract VMOption getVMOption (String name)

Returns a VMOption object for a VM option of the given name.

Returns
  • a VMOption object for a VM option of the given name.
Throws
NullPointerException if name is null.
IllegalArgumentException if a VM option of the given name does not exist.

public abstract void setVMOption (String name, String value)

Sets a VM option of the given name to the specified value. The new value will be reflected in a new VMOption object returned by the getVMOption(String) method or the getDiagnosticOptions() method. This method does not change the value of this VMOption object.

Parameters
name Name of a VM option
value New value of the VM option to be set
Throws
IllegalArgumentException if the VM option of the given name does not exist.
IllegalArgumentException if the new value is invalid.
IllegalArgumentException if the VM option is not writeable.
NullPointerException if name or value is null.
if a security manager exists and the caller does not have ManagementPermission("control").