モジュール jdk.jshell
パッケージ jdk.jshell.tool

インタフェースJavaShellToolBuilder


  • public interface JavaShellToolBuilder
    Javaシェル・ツール・インスタンスを構成および実行するインタフェース。 ビルダーのインスタンスは、静的builder()メソッドを使用して作成されます。 このビルダーは、オプションで構成メソッドで構成できます。 すべての構成メソッドは、連鎖初期化で使用するビルダー・インスタンスを返します。 すべての構成メソッドには、コールされない場合に使用される適切なデフォルトがあります。 構成メソッドを0個以上コールすると、run(java.lang.String...)をコールしてツールが起動されます。
    導入されたバージョン:
    9
    • メソッドの詳細

      • builder

        static JavaShellToolBuilder builder()
        JDK jshellツールを起動するためのビルダーを作成します。
        戻り値:
        jshellツールを構成および起動するために使用できるビルダー
      • in

        JavaShellToolBuilder in​(InputStream cmdIn,
                                InputStream userIn)
        入力チャネルを設定します。
        実装要件:
        このメソッドが呼び出されない場合、動作はin(System.in, null)の呼出しと同等である必要があります。
        パラメータ:
        cmdIn - コマンド入力のソース
        userIn - ユーザー・コードを実行するための入力のソース、またはcmdInからユーザー入力を抽出するためのnull
        戻り値:
        JavaShellToolBuilderインスタンス
      • out

        JavaShellToolBuilder out​(PrintStream output)
        出力チャネルを設定します。 out(output, output, output)と同じです。
        実装要件:
        どちらのoutメソッドもコールされない場合、動作はout(System.out)のコールと同等である必要があります。
        パラメータ:
        output - コマンド・フィードバック、コンソール・インタラクションおよびユーザー・コード出力の宛先
        戻り値:
        JavaShellToolBuilderインスタンス
      • out

        JavaShellToolBuilder out​(PrintStream cmdOut,
                                 PrintStream console,
                                 PrintStream userOut)
        出力チャネルを設定します。
        実装要件:
        どちらのoutメソッドもコールされない場合、動作はout(System.out, System.out, System.out)のコールと同等である必要があります。
        パラメータ:
        cmdOut - ユーザーに対するエラー・メッセージを含むコマンド・フィードバックの宛先
        console - コンソール・インタラクションの宛先
        userOut - ユーザー・コード出力の宛先。 たとえば、Helloを実行すると、ユーザー・スニペットSystem.out.println("Hello")がuserOutに移動します。
        戻り値:
        JavaShellToolBuilderインスタンス
      • err

        JavaShellToolBuilder err​(PrintStream error)
        エラー・チャネルを設定します。 err(error, error)と同じです。
        実装要件:
        どちらのerrメソッドもコールされない場合、動作はerr(System.err)のコールと同等である必要があります。
        パラメータ:
        error - ツール・エラーおよびユーザー・コード・エラーの宛先
        戻り値:
        JavaShellToolBuilderインスタンス
      • err

        JavaShellToolBuilder err​(PrintStream cmdErr,
                                 PrintStream userErr)
        エラー・チャネルを設定します。
        実装要件:
        どちらのerrメソッドもコールされない場合、動作はerr(System.err, System.err, System.err)のコールと同等である必要があります。
        パラメータ:
        cmdErr - ツール起動エラーおよび致命的エラーの宛先
        userErr - ユーザー・コード・エラー出力の宛先。 たとえば、Oopsを実行すると、ユーザー・スニペットSystem.err.println("Oops")がuserErrに移動します。
        戻り値:
        JavaShellToolBuilderインスタンス
      • persistence

        JavaShellToolBuilder persistence​(Preferences prefs)
        入力履歴および保持設定を含む永続情報の記憶域メカニズムを設定します。
        実装要件:
        どちらのpersistenceメソッドもコールされない場合は、ツールの標準永続性メカニズムを使用するようにしてください。
        パラメータ:
        prefs - 永続情報の取得および格納に使用されるPreferencesのインスタンス
        戻り値:
        JavaShellToolBuilderインスタンス
      • persistence

        JavaShellToolBuilder persistence​(Map<String,​String> prefsMap)
        入力履歴および保持設定を含む永続情報の記憶域メカニズムを設定します。
        実装要件:
        どちらのpersistenceメソッドもコールされない場合は、ツールの標準永続性メカニズムを使用するようにしてください。
        パラメータ:
        prefsMap - 永続情報の取得および格納に使用されるMapのインスタンス
        戻り値:
        JavaShellToolBuilderインスタンス
      • env

        JavaShellToolBuilder env​(Map<String,​String> vars)
        環境変数にソースを設定します。
        実装要件:
        このメソッドが呼び出されない場合、動作はenv(System.getenv())の呼出しと同等である必要があります。
        パラメータ:
        vars - 値への環境変数名のマップ
        戻り値:
        JavaShellToolBuilderインスタンス
      • locale

        JavaShellToolBuilder locale​(Locale locale)
        ロケールを設定します。
        実装要件:
        このメソッドが呼び出されない場合、動作はlocale(Locale.getDefault())の呼出しと同等である必要があります。
        パラメータ:
        locale - ロケール
        戻り値:
        JavaShellToolBuilderインスタンス
      • promptCapture

        JavaShellToolBuilder promptCapture​(boolean capture)
        コマンド取得プロンプトのオーバーライドを有効にするように設定します。
        実装要件:
        このメソッドが呼び出されない場合、動作はpromptCapture(false)の呼出しと同等である必要があります。
        パラメータ:
        capture - trueの場合、基本プロンプトはENQ文字、継続プロンプトはACK文字です。 falseの場合、プロンプトはset-upまたはユーザーの/setコマンドで設定されます。
        戻り値:
        JavaShellToolBuilderインスタンス
      • run

        void run​(String... arguments)
          throws Exception
        このインタフェースの他のメソッドで構成されたJavaシェル・ツールのインスタンスを実行します。 このコールは破壊的ではありません。構成済のビルダーからこのメソッドの複数のコールを実行できます。 Javaシェル・ツールの終了コードは無視されます。
        パラメータ:
        arguments - コマンドライン引数(オプションを含む)、
        例外:
        Exception - 予期しない致命的例外
      • start

        default int start​(String... arguments)
                   throws Exception
        このインタフェースの他のメソッドで構成されたJavaシェル・ツールのインスタンスを実行します。 このコールは破壊的ではありません。構成済のビルダーからこのメソッドの複数のコールを実行できます。
        実装要件:
        デフォルトの実装では常にゼロが返されます。 このインタフェースの実装は、このメソッドをオーバーライドして終了ステータスを返す必要があります。
        パラメータ:
        arguments - コマンドライン引数(オプションを含む)、
        戻り値:
        ツールが明示的に終了した終了ステータス(存在する場合)、成功した場合は0、失敗した場合は1
        例外:
        Exception - 予期しない致命的例外