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

*** 1,7 ****
  /*
!  * Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved.
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   *
   * This code is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License version 2 only, as
   * published by the Free Software Foundation.  Oracle designates this
--- 1,7 ----
  /*
!  * Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   *
   * This code is free software; you can redistribute it and/or modify it
   * under the terms of the GNU General Public License version 2 only, as
   * published by the Free Software Foundation.  Oracle designates this
*** 22,32 ****
   * or visit www.oracle.com if you need additional information or have any
   * questions.
   */
  
  /**
!  * Defines the Java Debugger Interface.
   *
   * @moduleGraph
   * @since 9
   */
  module jdk.jdi {
--- 22,109 ----
   * or visit www.oracle.com if you need additional information or have any
   * questions.
   */
  
  /**
!  * Defines the Java Debug Interface.
!  * <p>
!  * The Java&trade; 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.
!  * <p>
!  * JDI provides introspective access to a running virtual machine's state,
!  * Class, Array, Interface, and primitive types, and instances of those types.
!  * <p>
!  * 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.
!  * <p>
!  * JDI is the highest-layer of the Java Platform Debugger Architecture (JPDA).
!  * For more information on the Java Platform Debugger Architecture, see the <a
!  * href="{@docRoot}/../../../../technotes/guides/jpda/index.html"> Java
!  * Platform Debugger Architecture documentation</a> for this release and the <a
!  * href="http://java.sun.com/products/jpda">Java Platform Debugger Architecture
!  * website</a>.
!  * <p>
!  * <font size="+1"><b>Global Exceptions:</b></font>
!  * <p>
!  * This section documents exceptions which apply to the entire API and are thus
!  * not documented on individual methods.
!  * <blockquote>
!  *   <p>
!  *   <b>{@link com.sun.jdi.VMMismatchException}</b>
!  *   <p>
!  *   Any method on a {@link com.sun.jdi.Mirror} that takes a
!  *   {@code Mirror} as an parameter directly or indirectly (e.g., as a
!  *   element in a {@code List}) will throw {@link
!  *   com.sun.jdi.VMMismatchException} if the mirrors are from different virtual
!  *   machines.
!  *   <p>
!  *   <b>{@link java.lang.NullPointerException}</b>
!  *   <p>
!  *   Any method which takes a {@link java.lang.Object} as an parameter will
!  *   throw {@link java.lang.NullPointerException} if null is passed directly or
!  *   indirectly -- unless null is explicitly mentioned as a valid parameter.
!  * </blockquote>
!  * 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.
!  * <blockquote>
!  *   <p>
!  *   <b>{@link com.sun.jdi.VMDisconnectedException}</b>
!  *   <p>
!  *   Any method on {@link com.sun.jdi.ObjectReference}, {@link
!  *   com.sun.jdi.ReferenceType}, {@link com.sun.jdi.request.EventRequest},
!  *   {@link com.sun.jdi.StackFrame}, or {@link com.sun.jdi.VirtualMachine} or
!  *   which takes one of these directly or indirectly as an parameter may throw
!  *   {@link com.sun.jdi.VMDisconnectedException} if the target VM is
!  *   disconnected and the {@link com.sun.jdi.event.VMDisconnectEvent} has been
!  *   or is available to be read from the {@link com.sun.jdi.event.EventQueue}.
!  *   <p>
!  *   <b>{@link com.sun.jdi.VMOutOfMemoryException}</b>
!  *   <p>
!  *   Any method on {@link com.sun.jdi.ObjectReference}, {@link
!  *   com.sun.jdi.ReferenceType}, {@link com.sun.jdi.request.EventRequest},
!  *   {@link com.sun.jdi.StackFrame}, or {@link com.sun.jdi.VirtualMachine} or
!  *   which takes one of these directly or indirectly as an parameter may throw
!  *   {@link com.sun.jdi.VMOutOfMemoryException} if the target VM has run out of
!  *   memory.
!  *   <p>
!  *   <b>{@link com.sun.jdi.ObjectCollectedException}</b>
!  *   <p>
!  *   Any method on {@link com.sun.jdi.ObjectReference} or which directly or
!  *   indirectly takes {@code ObjectReference} as parameter may throw
!  *   {@link com.sun.jdi.ObjectCollectedException} if the mirrored object has
!  *   been garbage collected.
!  *   <p>
!  *   Any method on {@link com.sun.jdi.ReferenceType} or which directly or
!  *   indirectly takes {@code ReferenceType} as parameter may throw {@link
!  *   com.sun.jdi.ObjectCollectedException} if the mirrored type has been
!  *   unloaded.
!  * </blockquote>
   *
   * @moduleGraph
   * @since 9
   */
  module jdk.jdi {