< prev index next >

src/jdk.jdi/share/classes/module-info.java

Print this page




  29  * The Java&trade; Debug Interface (JDI) is a high level Java API providing
  30  * information useful for debuggers and similar systems needing access to the
  31  * running state of a (usually remote) virtual machine.
  32  * <p>
  33  * JDI provides introspective access to a running virtual machine's state,
  34  * Class, Array, Interface, and primitive types, and instances of those types.
  35  * <p>
  36  * JDI also provides explicit control over a virtual machine's execution.
  37  * The ability to suspend and resume threads, and to set breakpoints,
  38  * watchpoints, etc. Notification of exceptions, class loading, thread
  39  * creation, etc. The ability to inspect a suspended thread's state, local
  40  * variables, stack backtrace, etc.
  41  * <p>
  42  * JDI is the highest-layer of the
  43  * <a href="{@docRoot}/../specs/jpda/jpda.html">
  44  * Java Platform Debugger Architecture (JPDA)</a>.
  45  * <p>
  46  * This module includes a simple command-line debugger,
  47  * <em>{@index jdb jdb tool}</em>.
  48  *
  49  * <h2>Global Exceptions</h2>
  50  * <p>
  51  * This section documents exceptions which apply to the entire API and are thus
  52  * not documented on individual methods.
  53  * <blockquote>
  54  *   <p>
  55  *   <b>{@link com.sun.jdi.VMMismatchException}</b>
  56  *   <p>
  57  *   Any method on a {@link com.sun.jdi.Mirror} that takes a
  58  *   {@code Mirror} as an parameter directly or indirectly (e.g., as a
  59  *   element in a {@code List}) will throw {@link
  60  *   com.sun.jdi.VMMismatchException} if the mirrors are from different virtual
  61  *   machines.
  62  *   <p>
  63  *   <b>{@link java.lang.NullPointerException}</b>
  64  *   <p>
  65  *   Any method which takes a {@link java.lang.Object} as an parameter will
  66  *   throw {@link java.lang.NullPointerException} if null is passed directly or
  67  *   indirectly -- unless null is explicitly mentioned as a valid parameter.
  68  * </blockquote>
  69  * NOTE: The exceptions below may be thrown whenever the specified conditions




  29  * The Java&trade; Debug Interface (JDI) is a high level Java API providing
  30  * information useful for debuggers and similar systems needing access to the
  31  * running state of a (usually remote) virtual machine.
  32  * <p>
  33  * JDI provides introspective access to a running virtual machine's state,
  34  * Class, Array, Interface, and primitive types, and instances of those types.
  35  * <p>
  36  * JDI also provides explicit control over a virtual machine's execution.
  37  * The ability to suspend and resume threads, and to set breakpoints,
  38  * watchpoints, etc. Notification of exceptions, class loading, thread
  39  * creation, etc. The ability to inspect a suspended thread's state, local
  40  * variables, stack backtrace, etc.
  41  * <p>
  42  * JDI is the highest-layer of the
  43  * <a href="{@docRoot}/../specs/jpda/jpda.html">
  44  * Java Platform Debugger Architecture (JPDA)</a>.
  45  * <p>
  46  * This module includes a simple command-line debugger,
  47  * <em>{@index jdb jdb tool}</em>.
  48  *
  49  * <h3>Global Exceptions</h3>
  50  * <p>
  51  * This section documents exceptions which apply to the entire API and are thus
  52  * not documented on individual methods.
  53  * <blockquote>
  54  *   <p>
  55  *   <b>{@link com.sun.jdi.VMMismatchException}</b>
  56  *   <p>
  57  *   Any method on a {@link com.sun.jdi.Mirror} that takes a
  58  *   {@code Mirror} as an parameter directly or indirectly (e.g., as a
  59  *   element in a {@code List}) will throw {@link
  60  *   com.sun.jdi.VMMismatchException} if the mirrors are from different virtual
  61  *   machines.
  62  *   <p>
  63  *   <b>{@link java.lang.NullPointerException}</b>
  64  *   <p>
  65  *   Any method which takes a {@link java.lang.Object} as an parameter will
  66  *   throw {@link java.lang.NullPointerException} if null is passed directly or
  67  *   indirectly -- unless null is explicitly mentioned as a valid parameter.
  68  * </blockquote>
  69  * NOTE: The exceptions below may be thrown whenever the specified conditions


< prev index next >