1 /*
 2  * Copyright (c) 2015, 2025, 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 /**
27  * Defines tools for analysing dependencies in Java libraries and programs,
28  * including the <em>{@index jdeps jdeps tool}</em>,
29  * <em>{@index javap javap tool}</em>,
30  * <em>{@index jdeprscan jdeprscan tool}</em>, and
31  * <em>{@index jnativescan jnativescan tool}</em> tools.
32  *
33  * <p>
34  * This module provides the equivalent of command-line access to the
35  * <em>javap</em>, <em>jdeps</em>, and <em>jnativescan</em> tools via the
36  * {@link java.util.spi.ToolProvider ToolProvider} service provider
37  * interface (SPI)</p>
38  *
39  * <p> Instances of the tools can be obtained by calling
40  * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
41  * or the {@linkplain java.util.ServiceLoader service loader} with the name
42  * {@code "javap"} or {@code "jdeps"} as appropriate.
43  *
44  * <p>
45  * <em>jdeprscan</em> only exists as a command line tool, and does not provide
46  * any direct API.
47  *
48  * @toolGuide javap
49  * @toolGuide jdeprscan
50  * @toolGuide jdeps
51  * @toolGuide jnativescan
52  *
53  * @provides java.util.spi.ToolProvider
54  *     Use {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("javap")},
55  *     {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("jdeps")},
56  *     or {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst("jnativescan")}
57  *     to obtain an instance of a {@code ToolProvider} that provides the equivalent
58  *     of command-line access to the {@code javap}, {@code jdeps}, {@code jnativescan} tool.
59  *
60  * @moduleGraph
61  * @since 9
62  */
63 module jdk.jdeps {
64     requires java.compiler;
65     requires jdk.compiler;
66     requires jdk.internal.opt;
67 
68     uses com.sun.tools.javac.platform.PlatformProvider;
69 
70     provides java.util.spi.ToolProvider with
71         com.sun.tools.javap.Main.JavapToolProvider,
72         com.sun.tools.jdeps.Main.JDepsToolProvider,
73         com.sun.tools.jnativescan.Main.Provider;
74 }