Defines the Java Debug Interface.

The Java Debug Interface (JDI) is a high level Java API providing information useful for debuggers and similar systems needing access to the running state of a (usually remote) virtual machine.

JDI provides introspective access to a running virtual machine's state, Class, Array, Interface, and primitive types, and instances of those types.

JDI also provides explicit control over a virtual machine's execution. The ability to suspend and resume threads, and to set breakpoints, watchpoints, etc. Notification of exceptions, class loading, thread creation, etc. The ability to inspect a suspended thread's state, local variables, stack backtrace, etc.

JDI is the highest-layer of the Java Platform Debugger Architecture (JPDA).

This module includes a simple command-line debugger, jdb.

Global Exceptions

This section documents exceptions which apply to the entire API and are thus not documented on individual methods.

com.sun.jdi.VMMismatchException

Any method on a com.sun.jdi.Mirror that takes a Mirror as an parameter directly or indirectly (e.g., as a element in a List) will throw com.sun.jdi.VMMismatchException if the mirrors are from different virtual machines.

java.lang.NullPointerException

Any method which takes a java.lang.Object as an parameter will throw java.lang.NullPointerException if null is passed directly or indirectly -- unless null is explicitly mentioned as a valid parameter.

NOTE: The exceptions below may be thrown whenever the specified conditions are met but a guarantee that they are thrown only exists when a valid result cannot be returned.

com.sun.jdi.VMDisconnectedException

Any method on com.sun.jdi.ObjectReference, com.sun.jdi.ReferenceType, com.sun.jdi.request.EventRequest, com.sun.jdi.StackFrame, or com.sun.jdi.VirtualMachine or which takes one of these directly or indirectly as an parameter may throw com.sun.jdi.VMDisconnectedException if the target VM is disconnected and the com.sun.jdi.event.VMDisconnectEvent has been or is available to be read from the com.sun.jdi.event.EventQueue.

com.sun.jdi.VMOutOfMemoryException

Any method on com.sun.jdi.ObjectReference, com.sun.jdi.ReferenceType, com.sun.jdi.request.EventRequest, com.sun.jdi.StackFrame, or com.sun.jdi.VirtualMachine or which takes one of these directly or indirectly as an parameter may throw com.sun.jdi.VMOutOfMemoryException if the target VM has run out of memory.

com.sun.jdi.ObjectCollectedException

Any method on com.sun.jdi.ObjectReference or which directly or indirectly takes ObjectReference as parameter may throw com.sun.jdi.ObjectCollectedException if the mirrored object has been garbage collected.

Any method on com.sun.jdi.ReferenceType or which directly or indirectly takes ReferenceType as parameter may throw com.sun.jdi.ObjectCollectedException if the mirrored type has been unloaded.