モジュール jdk.jshell

パッケージ jdk.jshell

Javaプログラミング言語コードの"snippets"をインタラクティブに評価するRead-Eval-Printループ(REPL)などのツールを作成するためのインタフェースを提供します。 ここで、"snippet"は単一の式、文、または宣言です。 この機能を使用して、IDEなどのツールを拡張することも、スタンドアロンにすることもできます。

JShellは中央クラスです。 JShellのインスタンスは評価ステートを保持します。評価ステートは、ソース・スニペットの現在のセットと、生成された実行ステートの両方です。

各ソース・スニペットは、Snippetのサブクラスのインスタンスで表されます。 たとえば、文はStatementSnippetのインスタンスで表され、メソッド宣言はMethodSnippetのインスタンスで表されます。 スニペットは、JShell.eval(String)が1つ以上のコード・スニペットを含む入力で呼び出されたときに作成されます。

スニペットのコンパイル・ステータスの変更は、SnippetEventで報告されます。 スニペットのステータスには3つの主要な変更があります: evalで作成することができます。JShell.drop(jdk.jshell.Snippet)を使用してアクティブなソース状態から削除することができます。また、別のスニペットの状態変更の結果としてステータスを更新することもできます。 例えば: 与えられたjs、JShellのインスタンス、js.eval("int x = 5;")を実行すると、変数xがソース状態に追加され、xのVarSnippetの作成を記述するイベントが生成されます。 その後、js.eval("int timesx(int val) { return val * x; }")を実行すると、ソース状態にメソッドが追加され、timesxのMethodSnippetの作成を記述するイベントが生成されます。 varxがevalへの最初の呼び出しによって作成されたスニペットを保持し、js.drop(varx)を実行すると2つのイベントが生成されるものとします: 1つは変数スニペットのステータスをDROPPEDに変更するメソッド、もう1つはメソッド・スニペット(これで、xへの未解決の参照があります)を更新するメソッドです。

もちろん、APIの一般的なアプリケーションでは、入力は固定ストリングではなく、ユーザーからの入力となります。 以下は、APIを使ってREPLを実装する方法の非常に簡単な例です。 

 
     import java.io.ByteArrayInputStream;
     import java.io.Console;
     import java.util.List;
     import jdk.jshell.*;
     import jdk.jshell.Snippet.Status;

     class ExampleJShell {
         public static void main(String[] args) {
             Console console = System.console();
             try (JShell js = JShell.create()) {
                 do {
                     System.out.print("Enter some Java code: ");
                     String input = console.readLine();
                     if (input == null) {
                         break;
                     }
                     List<SnippetEvent> events = js.eval(input);
                     for (SnippetEvent e : events) {
                         StringBuilder sb = new StringBuilder();
                         if (e.causeSnippet == null) {
                             //  We have a snippet creation event
                             switch (e.status) {
                                 case VALID:
                                     sb.append("Successful ");
                                     break;
                                 case RECOVERABLE_DEFINED:
                                     sb.append("With unresolved references ");
                                     break;
                                 case RECOVERABLE_NOT_DEFINED:
                                     sb.append("Possibly reparable, failed  ");
                                     break;
                                 case REJECTED:
                                     sb.append("Failed ");
                                     break;
                             }
                             if (e.previousStatus == Status.NONEXISTENT) {
                                 sb.append("addition");
                             } else {
                                 sb.append("modification");
                             }
                             sb.append(" of ");
                             sb.append(e.snippet.source());
                             System.out.println(sb);
                             if (e.value != null) {
                                 System.out.printf("Value is: %s\n", e.value);
                             }
                             System.out.flush();
                         }
                     }
                 } while (true);
             }
             System.out.println("\nGoodbye");
         }
     }

ステータス変更イベントに登録するには、JShell.onSnippetEvent(java.util.function.Consumer)を使用します。 これらのイベントはevalとdropによってのみ生成され、これらのメソッドの戻り値はその呼び出しによって生成されたイベントのリストです。 したがって、上記の例のように、イベントを登録することなくイベントを使用することができます。

この例を試してみると、セミコロンで文または変数宣言を終了できないことが単に失敗することがわかります。 未完成のエントリ(例えば、所望のマルチ・ライン法)も1行後に失敗します。 SourceCodeAnalysisのユーティリティは、それらのようなケースに対処するために、ソース境界と完全性分析を提供します。 SourceCodeAnalysisは、タブ補完で使用される可能性のある、入力の推奨補完も提供します。

導入されたバージョン:
9