RFR 8223595: Consider updating jdk.jshell module description
Robert Field
robert.field at oracle.com
Mon May 13 00:06:09 UTC 2019
Please review....
Bug: https://bugs.openjdk.java.net/browse/JDK-8223595
sdiff -
25
26 /**
27 * This module provides support for
28 * Java Programming Language 'snippet' evaluating tools, such as
29 * Read-Eval-Print Loops (REPLs), including the <em>{@index jshell
jshell tool}</em> tool.
30 * Separate packages support building tools, configuring the execution of tools,
31 * and programmatically launching the existing Java shell tool.
------------------------------------------------------------------------
------------------------------------------------------------------------
25
26 /**
27 * Defines the JShell API and provides the <em>{@index jshell jshell
tool}</em> tool
28 * for evaluating snippets of Java code.
29 * The JShell API supports Java Programming Language 'snippet'
evaluating tools,
30 * such as Read-Eval-Print Loops (REPLs).
31 * Separate packages support building tools, configuring the execution of tools,
32 * and programmatically launching the existing Java shell tool.
------------------------------------------------------------------------
Old module description:
jdk.jshell
<https://download.java.net/java/early_access/jdk13/docs/api/jdk.jshell/module-summary.html>
This module provides support for Java Programming Language 'snippet'
evaluating tools, such as Read-Eval-Print Loops (REPLs), including
the/jshell/tool.
New module description:
jdk.jshell
Defines the JShell API and provides the/jshell/tool for evaluating
snippets of Java code.
Module doc:
Defines the JShell API and provides the/jshell/tool for evaluating
snippets of Java code. The JShell API supports Java Programming Language
'snippet' evaluating tools, such as Read-Eval-Print Loops (REPLs).
Separate packages support building tools, configuring the execution of
tools, and programmatically launching the existing Java shell tool.
The|jdk.jshell|is the package for creating 'snippet' evaluating tools.
Generally, this is only package that would be needed for creating tools.
The|jdk.jshell.spi|package specifies a Service Provider Interface (SPI)
for defining execution engine implementations for tools based on
the|jdk.jshell|API. The|jdk.jshell.execution|package provides standard
implementations of|jdk.jshell.spi|interfaces and supporting code. It
also serves as a library of functionality for defining new execution
engine implementations.
The|jdk.jshell.tool|package supports programmatically launching
the/jshell/tool.
The|jdk.jshell.execution|package contains implementations of the
interfaces in|jdk.jshell.spi|. Otherwise, the four packages are
independent, operate at different levels, and do not share functionality
or definitions.
Tool Guides:
jshell
<https://docs.oracle.com/pls/topic/lookup?ctx=javase13&id=jshell_tool_reference>
Since:
9
-Robert
More information about the kulla-dev
mailing list