langtools/src/jdk.jdeps/share/classes/module-info.java
author jjg
Thu, 15 Jun 2017 14:45:30 -0700
changeset 45680 6a7b5298fcf5
parent 44452 93f6470b1045
child 45683 6b4c8cffb90e
permissions -rw-r--r--
8181825: Add tool and services information to module summary Reviewed-by: mchung, rfield
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     1
/*
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
     2
 * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     4
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    10
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    15
 * accompanied this code).
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    16
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    20
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    23
 * questions.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    24
 */
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    25
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    26
/**
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    27
 * Defines tools for analysing dependencies in Java libraries and programs,
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    28
 * including the <em>{@index jdeps jdeps tool}</em>,
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    29
 * <em>{@index javap javap tool}</em> and
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    30
 * <em>{@index jdeprscan jdeprscan tool}</em> tools.
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    31
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    32
 * <p>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    33
 * This module provides the equivalent of command-line access to the
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    34
 * <em>javap</em> and <em>jdeps</em> tools via the
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    35
 * {@link java.util.spi.ToolProvider ToolProvider} service provider
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    36
 * interface (SPI)</p>
43862
a9b0f76e15bf 8174695: Fix @since in module-info.java in dev/langtools repo
mli
parents: 42407
diff changeset
    37
 *
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    38
 * <p> Instances of the tools can be obtained by calling
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    39
 * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    40
 * or the {@link java.util.ServiceLoader service loader} with the name
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    41
 * {@code "javap"} or {@code "jdeps"} as appropriate.
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    42
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    43
 * <p>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    44
 * <em>jdeprscan</em> only exists as a command line tool, and does not provide
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    45
 * any direct API.
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    46
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    47
 * <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    48
 * <dt class="simpleTagLabel">Tool Guides:
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    49
 * <dd>{@extLink javap_tool_reference javap},
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    50
 *     {@extLink jdeprscan_tool_reference jdeprscan},
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    51
 *     {@extLink jdeps_tool_reference jdeps}
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    52
 * </dl>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    53
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    54
 * @provides java.util.spi.ToolProvider
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    55
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    56
 * @moduleGraph
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 44452
diff changeset
    57
 * @since 9
40507
4413083331c7 8162576: Missing doclint check missing for modules
sadayapalam
parents: 36526
diff changeset
    58
 */
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    59
module jdk.jdeps {
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    60
    requires java.base;
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    61
    requires java.compiler;
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    62
    requires jdk.compiler;
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    63
    exports com.sun.tools.classfile to
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    64
        jdk.jlink;
41448
6689bce0cd65 8159855: Create an SPI for tools
jjg
parents: 40507
diff changeset
    65
42407
f3702cff2933 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41448
diff changeset
    66
    provides java.util.spi.ToolProvider with
f3702cff2933 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41448
diff changeset
    67
        com.sun.tools.javap.Main.JavapToolProvider,
f3702cff2933 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41448
diff changeset
    68
        com.sun.tools.jdeps.Main.JDepsToolProvider;
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    69
}