1 /*
2 * Copyright (c) 2015, 2026, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 import jdk.internal.javac.ParticipatesInPreview;
27
28 /**
29 * Defines tools for analysing dependencies in Java libraries and programs,
30 * including the <em>{@index jdeps jdeps tool}</em>,
31 * <em>{@index javap javap tool}</em>,
32 * <em>{@index jdeprscan jdeprscan tool}</em>, and
33 * <em>{@index jnativescan jnativescan tool}</em> tools.
34 *
35 * <p>
36 * This module provides the equivalent of command-line access to the
37 * <em>javap</em>, <em>jdeps</em>, and <em>jnativescan</em> tools via the
38 * {@link java.util.spi.ToolProvider ToolProvider} service provider
39 * interface (SPI)</p>
40 *
41 * <p> Instances of the tools can be obtained by calling
42 * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
43 * or the {@linkplain java.util.ServiceLoader service loader} with the name
44 * {@code "javap"} or {@code "jdeps"} as appropriate.
45 *
46 * <p>
47 * <em>jdeprscan</em> only exists as a command line tool, and does not provide
48 * any direct API.
49 *
50 * @toolGuide javap
51 * @toolGuide jdeprscan
52 * @toolGuide jdeps
53 * @toolGuide jnativescan
54 *
55 * @provides java.util.spi.ToolProvider
56 * Use {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("javap")},
57 * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("jdeps")},
58 * or {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("jnativescan")}
59 * to obtain an instance of a {@code ToolProvider} that provides the equivalent
60 * of command-line access to the {@code javap}, {@code jdeps}, {@code jnativescan} tool.
61 *
62 * @moduleGraph
63 * @since 9
64 */
65 @ParticipatesInPreview // Uses Valhalla reflective preview APIs, StackMapTable
66 module jdk.jdeps {
67 requires java.compiler;
68 requires jdk.compiler;
69 requires jdk.internal.opt;
70
71 uses com.sun.tools.javac.platform.PlatformProvider;
72
73 provides java.util.spi.ToolProvider with
74 com.sun.tools.javap.Main.JavapToolProvider,
75 com.sun.tools.jdeps.Main.JDepsToolProvider,
76 com.sun.tools.jnativescan.Main.Provider;
77 }