src/jdk.jshell/share/classes/module-info.java
changeset 47216 71c04702a3d5
parent 45684 2c5f2779c3d1
child 54930 43633b8e24c6
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.jshell/share/classes/module-info.java	Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * This module provides support for
+ * Java Programming Language 'snippet' evaluating tools, such as
+ * Read-Eval-Print Loops (REPLs), including the <em>{@index jshell jshell tool}</em> tool.
+ * Separate packages support building tools, configuring the execution of tools,
+ * and programmatically launching the existing Java shell tool.
+ * <p>
+ *     The {@link jdk.jshell} is the package for creating 'snippet' evaluating tools.
+ *     Generally, this is only package that would be needed for creating tools.
+ * </p>
+ * <p>
+ *     The {@link jdk.jshell.spi} package specifies a Service Provider Interface (SPI)
+ *     for defining execution engine implementations for tools based on the
+ *     {@link jdk.jshell} API. The {@link jdk.jshell.execution} package provides
+ *     standard implementations of {@link jdk.jshell.spi} interfaces and supporting code.  It
+ *     also serves as a library of functionality for defining new execution engine
+ *     implementations.
+ * </p>
+ * <p>
+ *     The {@link jdk.jshell.tool} package supports programmatically launching the
+ *     <em>jshell</em> tool.
+ * </p>
+ * <p>
+ *     The {@link jdk.jshell.execution} package contains implementations of the
+ *     interfaces in {@link jdk.jshell.spi}.  Otherwise, the four packages are
+ *     independent, operate at different levels, and do not share functionality or
+ *     definitions.
+ * </p>
+ *
+ * <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
+ * <dt class="simpleTagLabel">Tool Guides:
+ * <dd>{@extLink jshell_tool_reference jshell}
+ * </dl>
+ *
+ * @provides javax.tools.Tool
+ * @provides jdk.jshell.spi.ExecutionControlProvider
+ * @uses jdk.jshell.spi.ExecutionControlProvider
+ *
+ * @moduleGraph
+ * @since 9
+ */
+module jdk.jshell {
+    requires java.logging;
+    requires jdk.compiler;
+    requires jdk.internal.ed;
+    requires jdk.internal.le;
+    requires jdk.internal.opt;
+
+    requires transitive java.compiler;
+    requires transitive java.prefs;
+    requires transitive jdk.jdi;
+
+    exports jdk.jshell;
+    exports jdk.jshell.execution;
+    exports jdk.jshell.spi;
+    exports jdk.jshell.tool;
+
+    uses jdk.jshell.spi.ExecutionControlProvider;
+    uses jdk.internal.editor.spi.BuildInEditorProvider;
+
+    provides javax.tools.Tool with
+        jdk.internal.jshell.tool.JShellToolProvider;
+    provides jdk.jshell.spi.ExecutionControlProvider with
+        jdk.jshell.execution.JdiExecutionControlProvider,
+        jdk.jshell.execution.LocalExecutionControlProvider,
+        jdk.jshell.execution.FailOverExecutionControlProvider;
+}