モジュール jdk.jshell

パッケージ jdk.jshell

Javaプログラミング言語コードの「スニペット」を対話形式で評価するRead-Eval-Print Loop (REPL)などのツールを作成するためのインタフェースを提供します。 ここで、"snippet"は単一の式、文または宣言です。 この機能を使用すると、IDEなどのツールを拡張したり、スタンドアロンにしたりできます。

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

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

スニペットのコンパイル・ステータスに対する変更は、SnippetEventで報告されます。 スニペットのステータスには、evalを使用して作成し、JShell.drop(jdk.jshell.Snippet)を使用してアクティブなソース状態から削除し、別のスニペットのステータス変更の結果としてステータスを更新できるという3つの大きな変更があります。 たとえば、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