8181639: Add tool and services information to module summary

Reviewed-by: alanb, psandoz, lancea
This commit is contained in:
Mandy Chung 2017-06-07 21:15:06 -07:00
parent fd73998610
commit 08c80bdefc
35 changed files with 282 additions and 65 deletions

View File

@ -10,7 +10,9 @@ java.corba \
java.transaction \
java.xml.bind \
java.xml.ws \
java.xml.ws.annotation
java.xml.ws.annotation \
jdk.xml.bind \
jdk.xml.ws
aggregator_modules=\
java.se \

View File

@ -26,6 +26,51 @@
/**
* Defines the foundational APIs of the Java SE Platform.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Providers:</dt>
* <dd> The JDK implementation of this module provides an implementation of
* the {@index jrt jrt} {@linkplain java.nio.file.spi.FileSystemProvider
* file system provider} to enumerate and read the class and resource
* files in a run-time image.
* The jrt file system can be created by calling
* {@link java.nio.file.FileSystems#newFileSystem
* FileSystems.newFileSystem(URI.create("jrt:/"))}.
* <p></dd>
* <dt class="simpleTagLabel">Tool Guides:</dt>
* <dd> {@extLink java_tool_reference java launcher},
* {@extLink keytool_tool_reference keytool}</dd>
* </dl>
*
* @provides java.nio.file.spi.FileSystemProvider
*
* @uses java.lang.System.LoggerFinder
* @uses java.net.ContentHandlerFactory
* @uses java.net.spi.URLStreamHandlerProvider
* @uses java.nio.channels.spi.AsynchronousChannelProvider
* @uses java.nio.channels.spi.SelectorProvider
* @uses java.nio.charset.spi.CharsetProvider
* @uses java.nio.file.spi.FileSystemProvider
* @uses java.nio.file.spi.FileTypeDetector
* @uses java.security.Provider
* @uses java.text.spi.BreakIteratorProvider
* @uses java.text.spi.CollatorProvider
* @uses java.text.spi.DateFormatProvider
* @uses java.text.spi.DateFormatSymbolsProvider
* @uses java.text.spi.DecimalFormatSymbolsProvider
* @uses java.text.spi.NumberFormatProvider
* @uses java.time.chrono.AbstractChronology
* @uses java.time.chrono.Chronology
* @uses java.time.zone.ZoneRulesProvider
* @uses java.util.spi.CalendarDataProvider
* @uses java.util.spi.CalendarNameProvider
* @uses java.util.spi.CurrencyNameProvider
* @uses java.util.spi.LocaleNameProvider
* @uses java.util.spi.ResourceBundleControlProvider
* @uses java.util.spi.ResourceBundleProvider
* @uses java.util.spi.TimeZoneNameProvider
* @uses java.util.spi.ToolProvider
* @uses javax.security.auth.spi.LoginModule
*
* @moduleGraph
* @since 9
*/

View File

@ -27,6 +27,24 @@
* Defines the AWT and Swing user interface toolkits, plus APIs for
* accessibility, audio, imaging, printing, and JavaBeans.
*
* @uses java.awt.im.spi.InputMethodDescriptor
* @uses javax.accessibility.AccessibilityProvider
* @uses javax.imageio.spi.ImageInputStreamSpi
* @uses javax.imageio.spi.ImageOutputStreamSpi
* @uses javax.imageio.spi.ImageReaderSpi
* @uses javax.imageio.spi.ImageTranscoderSpi
* @uses javax.imageio.spi.ImageWriterSpi
* @uses javax.print.PrintServiceLookup
* @uses javax.print.StreamPrintServiceFactory
* @uses javax.sound.midi.spi.MidiDeviceProvider
* @uses javax.sound.midi.spi.MidiFileReader
* @uses javax.sound.midi.spi.MidiFileWriter
* @uses javax.sound.midi.spi.SoundbankReader
* @uses javax.sound.sampled.spi.AudioFileReader
* @uses javax.sound.sampled.spi.AudioFileWriter
* @uses javax.sound.sampled.spi.FormatConversionProvider
* @uses javax.sound.sampled.spi.MixerProvider
*
* @moduleGraph
* @since 9
*/

View File

@ -24,27 +24,27 @@
*/
/**
* Defines the RMI Connector for the Java Management Extensions (JMX) Remote API.
* <P>
* The {@linkplain javax.management.remote.rmi RMI connector} is a connector
* for the JMX Remote API that uses RMI to transmit client requests to a remote
* MBean server.
* Defines the {@linkplain javax.management.remote.rmi RMI connector}
* for the Java Management Extensions (JMX) Remote API.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Providers:</dt>
* <dd>This module provides
* {@link javax.management.remote.JMXConnectorProvider} service
* that creates the JMX connector clients using RMI protocol.
* Instances of {@code JMXConnector} can be obtained via the
* {@link javax.management.remote.JMXConnectorFactory#newJMXConnector
* JMXConnectorFactory.newJMXConnector} factory method.
* It also provides {@link javax.management.remote.JMXConnectorServerProvider} service
* that creates the JMX connector servers using RMI protocol.
* Instances of {@code JMXConnectorServer} can be obtained via the
* {@link javax.management.remote.JMXConnectorServerFactory#newJMXConnectorServer
* JMXConnectorServerFactory.newJMXConnectorServer} factory method.
* </dd>
* </dl>
*
* @provides javax.management.remote.JMXConnectorProvider
* A provider of {@code JMXConnector} for the RMI protocol.<br>
* Instances of {@code JMXConnector} using the RMI protocol
* are usually created by the {@link
* javax.management.remote.JMXConnectorFactory} which will locate
* and load the appropriate {@code JMXConnectorProvider} service
* implementation for the given protocol.
*
* @provides javax.management.remote.JMXConnectorServerProvider
* A provider of {@code JMXConnectorServer} for the RMI protocol.<br>
* Instances of {@code JMXConnectorServer} using the RMI protocol
* are usually created by the {@link
* javax.management.remote.JMXConnectorServerFactory} which will locate
* and load the appropriate {@code JMXConnectorServerProvider} service
* implementation for the given protocol.
*
* @moduleGraph
* @since 9

View File

@ -29,6 +29,9 @@
* The JMX API consists of interfaces for monitoring and management of the
* JVM and other components in the Java runtime.
*
* @uses javax.management.remote.JMXConnectorProvider
* @uses javax.management.remote.JMXConnectorServerProvider
*
* @moduleGraph
* @since 9
*/

View File

@ -26,6 +26,8 @@
/**
* Defines the Preferences API.
*
* @uses java.util.prefs.PreferencesFactory
*
* @moduleGraph
* @since 9
*/
@ -35,4 +37,3 @@ module java.prefs {
exports java.util.prefs;
uses java.util.prefs.PreferencesFactory;
}

View File

@ -26,6 +26,21 @@
/**
* Defines the Remote Method Invocation (RMI) API.
*
* <p> The JDK implementation of this module includes
* the <em>{@index rmiregistry rmiregistry tool}</em> tool to start a remote
* object registry, and the <em>{@index rmid rmid tool}</em> tool to start
* the activation system daemon.
*
* <p>
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:</dt>
* <dd> {@extLink rmiregistry_tool_reference rmiregistry},
* {@extLink rmid_tool_reference rmid}
* </dd>
* </dl>
*
* @uses java.rmi.server.RMIClassLoaderSpi
*
* @moduleGraph
* @since 9
*/

View File

@ -26,6 +26,19 @@
/**
* Defines the Scripting API.
*
* <p> The JDK implementation of this module includes a language-independent
* command-line script shell, <em>{@index jrunscript jrunscript tool}</em>,
* that supports executing JavaScript and other languages if its corresponding
* script engine is installed.
*
* <p>
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd> {@extLink jrunscript_tool_reference jrunscript}</dd>
* </dl>
*
* @uses javax.script.ScriptEngineFactory
*
* @moduleGraph
* @since 9
*/
@ -33,4 +46,3 @@ module java.scripting {
exports javax.script;
uses javax.script.ScriptEngineFactory;
}

View File

@ -29,6 +29,15 @@
* The modules defining CORBA and Java EE APIs are not required by
* this module, but they are required by {@code java.se.ee}.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Optional for Java SE Platform:</dt>
* <dd>
* <a href="../specs/jni/index.html">Java Native Interface (JNI)</a><br>
* <a href="../specs/jvmti.html">Java Virtual Machine Tool Interface (JVM TI)</a><br>
* <a href="../specs/jdwp/jdwp-spec.html">Java Debug Wire Protocol (JDWP)</a><br>
* </dd>
* </dl>
*
* @moduleGraph
* @since 9
*/

View File

@ -26,6 +26,8 @@
/**
* Defines the JDBC RowSet API.
*
* @uses javax.sql.rowset.RowSetFactory
*
* @moduleGraph
* @since 9
*/
@ -39,4 +41,3 @@ module java.sql.rowset {
exports javax.sql.rowset.spi;
uses javax.sql.rowset.RowSetFactory;
}

View File

@ -26,6 +26,8 @@
/**
* Defines the JDBC API.
*
* @uses java.sql.Driver
*
* @moduleGraph
* @since 9
*/
@ -38,4 +40,3 @@ module java.sql {
exports javax.transaction.xa;
uses java.sql.Driver;
}

View File

@ -26,6 +26,8 @@
/**
* Defines the attach API.
*
* @uses com.sun.tools.attach.spi.AttachProvider
*
* @moduleGraph
* @since 9
*/
@ -39,4 +41,3 @@ module jdk.attach {
uses com.sun.tools.attach.spi.AttachProvider;
provides com.sun.tools.attach.spi.AttachProvider with sun.tools.attach.AttachProviderImpl;
}

View File

@ -24,9 +24,11 @@
*/
/**
* {@link java.nio.charset.Charset Charset} provider for the charsets that
* Provides {@link java.nio.charset.Charset charsets} that
* are not in {@code java.base} (mostly double byte and IBM charsets).
*
* @provides java.nio.charset.spi.CharsetProvider
*
* @moduleGraph
* @since 9
*/
@ -34,4 +36,3 @@ module jdk.charsets {
provides java.nio.charset.spi.CharsetProvider
with sun.nio.cs.ext.ExtendedCharsets;
}

View File

@ -24,7 +24,9 @@
*/
/**
* The SunPKCS11 security provider.
* Provides the implementation of the SunPKCS11 security provider.
*
* @provides java.security.Provider
*
* @moduleGraph
* @since 9
@ -34,4 +36,3 @@ module jdk.crypto.cryptoki {
requires jdk.crypto.ec;
provides java.security.Provider with sun.security.pkcs11.SunPKCS11;
}

View File

@ -24,7 +24,9 @@
*/
/**
* The SunEC security provider.
* Provides the implementation of the SunEC security provider.
*
* @provides java.security.Provider
*
* @moduleGraph
* @since 9
@ -32,4 +34,3 @@
module jdk.crypto.ec {
provides java.security.Provider with sun.security.ec.SunEC;
}

View File

@ -24,8 +24,9 @@
*/
/**
* The SunMSCAPI security provider.
* Provides the implementation of the SunMSCAPI security provider.
*
* @provides java.security.Provider
* @moduleGraph
* @since 9
*/

View File

@ -24,8 +24,9 @@
*/
/**
* The OracleUCrypto security provider.
* Provides the implementation of the OracleUCrypto security provider.
*
* @provides java.security.Provider
* @moduleGraph
* @since 9
*/

View File

@ -24,7 +24,7 @@
*/
/**
* Implementation of the edit pad service.
* Provides the implementation of the edit pad service used by {@link jdk.jshell}.
*
* @moduleGraph
* @since 9

View File

@ -26,6 +26,8 @@
/**
* Defines the JDK-specific API for HTTP server.
*
* @uses com.sun.net.httpserver.spi.HttpServerProvider
*
* @moduleGraph
* @since 9
*/
@ -35,4 +37,3 @@ module jdk.httpserver {
exports com.sun.net.httpserver.spi;
uses com.sun.net.httpserver.spi.HttpServerProvider;
}

View File

@ -25,7 +25,21 @@
/**
* Defines tools for manipulating Java Archive (JAR) files,
* including the jar and jarsigner tools.
* including the <em>{@index jar jar tool}</em> and
* <em>{@index jarsigner jarsigner tool}</em> tools.
*
* <p> This module provides the equivalent of command-line access to
* <em>jar</em> via the {@link java.util.spi.ToolProvider ToolProvider} SPI.
* Instances of the tool can be obtained by calling
* {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
* or the {@link java.util.ServiceLoader service loader} with the name
* {@code "jar"}.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink jar_tool_reference jar},
* {@extLink jarsigner_tool_reference jarsigner}
* </dl>
*
* @moduleGraph
* @since 9
@ -36,4 +50,3 @@ module jdk.jartool {
provides java.util.spi.ToolProvider with sun.tools.jar.JarToolProvider;
}

View File

@ -24,8 +24,20 @@
*/
/**
* Defines tools for diagnostics and troubleshooting a JVM,
* including the jcmd, jps, jstat and other diagnostics tools.
* Defines tools for diagnostics and troubleshooting a JVM
* such as the <em>{@index jcmd jcmd tool}</em>, <em>{@index jps jps tool}</em>,
* <em>{@index jstat jstat tool}</em> tools.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>
* {@extLink jcmd_tool_reference jcmd},
* {@extLink jinfo_tool_reference jinfo},
* {@extLink jmap_tool_reference jmap},
* {@extLink jps_tool_reference jps},
* {@extLink jstack_tool_reference jstack},
* {@extLink jstat_tool_reference jstat}
* </dl>
*
* @moduleGraph
* @since 9

View File

@ -24,8 +24,16 @@
*/
/**
* Defines the JMX graphical tool, jconsole, for monitoring and managing
* a running application.
* Defines the JMX graphical tool, <em>{@index jconsole jconsole}</em>,
* for monitoring and managing a running application.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink jconsole_tool_reference jconsole},
* {@extLink using_jconsole Using JConsole}
* </dl>
*
* @uses com.sun.tools.jconsole.JConsolePlugin
*
* @moduleGraph
* @since 9

View File

@ -45,8 +45,7 @@
* 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 style="font-size:larger">
* <b>Global Exceptions:</b>
* <h3>Global Exceptions</h3>
* <p>
* This section documents exceptions which apply to the entire API and are thus
* not documented on individual methods.
@ -103,6 +102,21 @@
* unloaded.
* </blockquote>
*
* <h3>jdb</h3>
*
* <em>{@index jdb jdb tool}</em> is a simple command-line debugger provided
* in this module.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink jdb_tool_reference jdb}
* </dl>
*
* @provides com.sun.jdi.connect.Connector
*
* @uses com.sun.jdi.connect.Connector
* @uses com.sun.jdi.connect.spi.TransportService
*
* @moduleGraph
* @since 9
*/
@ -127,4 +141,3 @@ module jdk.jdi {
com.sun.tools.jdi.SocketListeningConnector,
com.sun.tools.jdi.SunCommandLineLauncher;
}

View File

@ -24,11 +24,12 @@
*/
/**
* Java Debug Wire Protocol.
* Provides the implementation of the Java Debug Wire Protocol (JDWP) agent.
*
* @moduleGraph
* @since 9
* @see <a href="../specs/jdwp/jdwp-spec.html">JDWP Specification</a>
* @see <a href="../specs/jdwp/jdwp-transport.html">JDWP Transport Specification</a>
*/
module jdk.jdwp.agent {
}

View File

@ -24,7 +24,31 @@
*/
/**
* Defines the Java linker tool, jlink.
* Defines the <em>{@index jlink jlink tool}</em> tool for creating run-time
* images, the <em>{@index jmod jmod tool}</em> tool for creating and manipulating
* JMOD files, and the <em>{@index jimage jimage tool}</em> tool for inspecting
* the JDK implementation-specific container file for classes and resources.
*
* <p> This module provides the equivalent of command-line access to the
* <em>{@extLink jlink_tool_reference jlink}</em> and
* <em>{@extLink jmod_tool_reference jmod}</em> tools via the
* {@link java.util.spi.ToolProvider ToolProvider} SPI.
* Instances of the tools can be obtained by calling
* {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
* or the {@link java.util.ServiceLoader service loader} with the name
* {@code "jlink"} or {@code "jmod"} as appropriate.
*
* <p> <em>{@extLink jimage_tool_reference jimage}</em> only exists
* as a command-line tool, and does not provide any direct API.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink jlink_tool_reference jlink},
* {@extLink jmod_tool_reference jmod},
* {@extLink jimage_tool_reference jimage}
* </dl>
*
* @provides java.util.spi.ToolProvider
*
* @moduleGraph
* @since 9

View File

@ -24,8 +24,13 @@
*/
/**
* Defines the tool for starting a daemon for the jstat tool to monitor
* JVM statistics remotely.
* Defines the <em>{@index jstatd jstatd tool}</em> tool for starting a daemon
* for the jstat tool to monitor JVM statistics remotely.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink jstatd_tool_reference jstatd}
* </dl>
*
* @moduleGraph
* @since 9

View File

@ -24,7 +24,7 @@
*/
/**
* Locale data provider for locales other than {@linkplain java.util.Locale#US US locale}.
* Provides the locale data for locales other than {@linkplain java.util.Locale#US US locale}.
*
* @moduleGraph
* @since 9

View File

@ -24,7 +24,12 @@
*/
/**
* Define the JMX management agent.
* Defines the JMX management agent.
*
* <p> This module allows a Java Virtual Machine to be monitored and managed
* via JMX API. See more information from the
* {@extLink monitoring_and_management_using_jmx_technology
* Monitoring and Management Using JMX} guide.
*
* @moduleGraph
* @since 9

View File

@ -24,8 +24,9 @@
*/
/**
* DNS Java Naming provider.
* Provides the implementation of the DNS Java Naming provider.
*
* @provides javax.naming.spi.InitialContextFactory
* @moduleGraph
* @since 9
*/
@ -38,4 +39,3 @@ module jdk.naming.dns {
provides javax.naming.spi.InitialContextFactory
with com.sun.jndi.dns.DnsContextFactory;
}

View File

@ -24,8 +24,9 @@
*/
/**
* RMI Java Naming provider.
* Provides the implementation of the RMI Java Naming provider.
*
* @provides javax.naming.spi.InitialContextFactory
* @moduleGraph
* @since 9
*/
@ -39,4 +40,3 @@ module jdk.naming.rmi {
exports com.sun.jndi.url.rmi to java.naming;
exports com.sun.jndi.rmi.registry to java.rmi;
}

View File

@ -25,8 +25,15 @@
/**
* Defines tools for transforming a JAR file into a compressed pack200 file
* and transforming a packed file into a JAR file, including the pack200,
* and unpack200 tools.
* and transforming a packed file into a JAR file, including the
* <em>{@index pack200 pack200 tool}</em> and
* <em>{@index unpack200 unpack200 tool}</em> tools.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink pack200_tool_reference pack200},
* {@extLink unpack200_tool_reference unpack200}
* </dl>
*
* @moduleGraph
* @since 9

View File

@ -24,7 +24,13 @@
*/
/**
* GUI tool for managing policy files.
* Defines the GUI tool for managing policy files
* called <em>{@index policytool policytool}</em>.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink policytool_tool_reference policytool}
* </dl>
*
* @since 9
* @deprecated
@ -39,4 +45,3 @@ module jdk.policytool {
requires java.security.jgss;
requires jdk.security.jgss;
}

View File

@ -24,10 +24,15 @@
*/
/**
* Defines the rmic compiler for generating stubs and skeletons using
* the Java Remote Method Protocol (JRMP) and
* Defines the <em>{@index rmic rmic}</em> compiler for generating stubs and
* skeletons using the Java Remote Method Protocol (JRMP) and
* stubs and tie class files (IIOP protocol) for remote objects.
*
* <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
* <dt class="simpleTagLabel">Tool Guides:
* <dd>{@extLink rmic_tool_reference rmic}
* </dl>
*
* @moduleGraph
* @since 9
*/

View File

@ -24,9 +24,10 @@
*/
/**
* Contains the implementation of the javax.security.auth.* interfaces and
* various authentication modules.
* Provides the implementation of the {@code javax.security.auth.*}
* interfaces and various authentication modules.
*
* @provides javax.security.auth.spi.LoginModule
* @moduleGraph
* @since 9
*/
@ -47,4 +48,3 @@ module jdk.security.auth {
com.sun.security.auth.module.LdapLoginModule,
com.sun.security.auth.module.NTLoginModule;
}

View File

@ -24,12 +24,17 @@
*/
/**
* Zip file system provider.
* Provides the implementation of the zip file system provider.
*
* <p> The zip file system provider treats a zip or JAR file as a file system
* and provides the ability to manipulate the contents of the file.
* The zip file system provider can be created by
* {@link java.nio.file.FileSystems#newFileSystem} if installed.
*
* @provides java.nio.file.spi.FileSystemProvider
* @moduleGraph
* @since 9
*/
module jdk.zipfs {
provides java.nio.file.spi.FileSystemProvider with jdk.nio.zipfs.ZipFileSystemProvider;
}