src/jdk.jdi/share/classes/module-info.java
author jwilhelm
Thu, 27 Jun 2019 03:13:54 +0200
changeset 55515 4c52949a3487
parent 55209 64fe51ee940e
permissions -rw-r--r--
Added tag jdk-13+27 for changeset b7f68ddec66f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     1
/*
54950
46ae54c3026d 8223663: Update links for tool guides
jjg
parents: 47216
diff changeset
     2
 * Copyright (c) 2014, 2019, Oracle and/or its affiliates. All rights reserved.
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     4
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    10
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    15
 * accompanied this code).
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    16
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    20
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    23
 * questions.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    24
 */
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    25
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
    26
/**
44788
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    27
 * Defines the Java Debug Interface.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    28
 * <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    29
 * The Java&trade; Debug Interface (JDI) is a high level Java API providing
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    30
 * information useful for debuggers and similar systems needing access to the
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    31
 * running state of a (usually remote) virtual machine.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    32
 * <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    33
 * JDI provides introspective access to a running virtual machine's state,
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    34
 * Class, Array, Interface, and primitive types, and instances of those types.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    35
 * <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    36
 * JDI also provides explicit control over a virtual machine's execution.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    37
 * The ability to suspend and resume threads, and to set breakpoints,
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    38
 * watchpoints, etc. Notification of exceptions, class loading, thread
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    39
 * creation, etc. The ability to inspect a suspended thread's state, local
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    40
 * variables, stack backtrace, etc.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    41
 * <p>
45660
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    42
 * JDI is the highest-layer of the
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    43
 * <a href="{@docRoot}/../specs/jpda/jpda.html">
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    44
 * Java Platform Debugger Architecture (JPDA)</a>.
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    45
 * <p>
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    46
 * This module includes a simple command-line debugger,
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    47
 * <em>{@index jdb jdb tool}</em>.
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
    48
 *
55209
64fe51ee940e 8225309: HTML issues in jdk.jdi module
jjg
parents: 54950
diff changeset
    49
 * <h2>Global Exceptions</h2>
44788
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    50
 * <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    51
 * This section documents exceptions which apply to the entire API and are thus
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    52
 * not documented on individual methods.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    53
 * <blockquote>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    54
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    55
 *   <b>{@link com.sun.jdi.VMMismatchException}</b>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    56
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    57
 *   Any method on a {@link com.sun.jdi.Mirror} that takes a
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    58
 *   {@code Mirror} as an parameter directly or indirectly (e.g., as a
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    59
 *   element in a {@code List}) will throw {@link
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    60
 *   com.sun.jdi.VMMismatchException} if the mirrors are from different virtual
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    61
 *   machines.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    62
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    63
 *   <b>{@link java.lang.NullPointerException}</b>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    64
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    65
 *   Any method which takes a {@link java.lang.Object} as an parameter will
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    66
 *   throw {@link java.lang.NullPointerException} if null is passed directly or
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    67
 *   indirectly -- unless null is explicitly mentioned as a valid parameter.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    68
 * </blockquote>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    69
 * NOTE: The exceptions below may be thrown whenever the specified conditions
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    70
 * are met but a guarantee that they are thrown only exists when a valid result
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    71
 * cannot be returned.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    72
 * <blockquote>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    73
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    74
 *   <b>{@link com.sun.jdi.VMDisconnectedException}</b>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    75
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    76
 *   Any method on {@link com.sun.jdi.ObjectReference}, {@link
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    77
 *   com.sun.jdi.ReferenceType}, {@link com.sun.jdi.request.EventRequest},
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    78
 *   {@link com.sun.jdi.StackFrame}, or {@link com.sun.jdi.VirtualMachine} or
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    79
 *   which takes one of these directly or indirectly as an parameter may throw
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    80
 *   {@link com.sun.jdi.VMDisconnectedException} if the target VM is
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    81
 *   disconnected and the {@link com.sun.jdi.event.VMDisconnectEvent} has been
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    82
 *   or is available to be read from the {@link com.sun.jdi.event.EventQueue}.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    83
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    84
 *   <b>{@link com.sun.jdi.VMOutOfMemoryException}</b>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    85
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    86
 *   Any method on {@link com.sun.jdi.ObjectReference}, {@link
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    87
 *   com.sun.jdi.ReferenceType}, {@link com.sun.jdi.request.EventRequest},
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    88
 *   {@link com.sun.jdi.StackFrame}, or {@link com.sun.jdi.VirtualMachine} or
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    89
 *   which takes one of these directly or indirectly as an parameter may throw
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    90
 *   {@link com.sun.jdi.VMOutOfMemoryException} if the target VM has run out of
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    91
 *   memory.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    92
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    93
 *   <b>{@link com.sun.jdi.ObjectCollectedException}</b>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    94
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    95
 *   Any method on {@link com.sun.jdi.ObjectReference} or which directly or
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    96
 *   indirectly takes {@code ObjectReference} as parameter may throw
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    97
 *   {@link com.sun.jdi.ObjectCollectedException} if the mirrored object has
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    98
 *   been garbage collected.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
    99
 *   <p>
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
   100
 *   Any method on {@link com.sun.jdi.ReferenceType} or which directly or
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
   101
 *   indirectly takes {@code ReferenceType} as parameter may throw {@link
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
   102
 *   com.sun.jdi.ObjectCollectedException} if the mirrored type has been
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
   103
 *   unloaded.
4528ad632cc0 8178037: Move information from jdi-overview.html into jdk.jdi module-info.java
ihse
parents: 44417
diff changeset
   104
 * </blockquote>
43710
8fa2058eb740 8173957: Fix @since in module-info.java in dev/jdk repo
mli
parents: 42338
diff changeset
   105
 *
45528
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   106
 *
54950
46ae54c3026d 8223663: Update links for tool guides
jjg
parents: 47216
diff changeset
   107
 * @toolGuide jdb
45528
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   108
 *
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   109
 * @provides com.sun.jdi.connect.Connector
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   110
 *
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   111
 * @uses com.sun.jdi.connect.Connector
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   112
 * @uses com.sun.jdi.connect.spi.TransportService
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 45001
diff changeset
   113
 *
44417
a431edba1629 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 43710
diff changeset
   114
 * @moduleGraph
43710
8fa2058eb740 8173957: Fix @since in module-info.java in dev/jdk repo
mli
parents: 42338
diff changeset
   115
 * @since 9
45660
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
   116
 * @see <a href="{@docRoot}/../specs/jpda/jpda.html">
b7894e61387c 8181834: Broken link in jdk.jdi module documentation
mchung
parents: 45528
diff changeset
   117
 * Java Platform Debugger Architecture (JPDA)</a>
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   118
 */
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   119
module jdk.jdi {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   120
    requires jdk.attach;
40984
b0caaa706f76 8166237: jdk.jdi missing requires jdk.jdwp.agent
mchung
parents: 36511
diff changeset
   121
    requires jdk.jdwp.agent;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   122
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   123
    exports com.sun.jdi;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   124
    exports com.sun.jdi.connect;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   125
    exports com.sun.jdi.connect.spi;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   126
    exports com.sun.jdi.event;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   127
    exports com.sun.jdi.request;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   128
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   129
    uses com.sun.jdi.connect.Connector;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   130
    uses com.sun.jdi.connect.spi.TransportService;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   131
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   132
    // windows shared memory connector providers are added at build time
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   133
    provides com.sun.jdi.connect.Connector with
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   134
        com.sun.tools.jdi.ProcessAttachingConnector,
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   135
        com.sun.tools.jdi.RawCommandLineLauncher,
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   136
        com.sun.tools.jdi.SocketAttachingConnector,
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   137
        com.sun.tools.jdi.SocketListeningConnector,
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41755
diff changeset
   138
        com.sun.tools.jdi.SunCommandLineLauncher;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
   139
}