モジュール jdk.jshell

パッケージ jdk.jshell.tool

インタフェースJavaShellToolBuilder

public interface JavaShellToolBuilder

Javaシェル・ツール・インスタンスを構成および実行するインタフェース。 ビルダーのインスタンスは、静的builder()メソッドを使用して作成されます。 このビルダーは、オプションで構成メソッドで構成できます。 すべての構成メソッドは、連鎖初期化で使用するビルダー・インスタンスを返します。 すべての構成メソッドは、呼び出されない場合に使用される適切なデフォルトを持っています。 0個以上の構成メソッドのコール後、ツールはrun(java.lang.String...)をコールして起動されます。

導入されたバージョン:

9

メソッドのサマリー

修飾子と型	メソッド	説明
static JavaShellToolBuilder	builder()	JDK jshellツールを起動するためのビルダーを作成します。
JavaShellToolBuilder	env(Map<String,String> vars)	環境変数のソースを設定します。
JavaShellToolBuilder	err(PrintStream error)	エラー・チャネルを設定します。
JavaShellToolBuilder	err(PrintStream cmdErr, PrintStream userErr)	エラー・チャネルを設定します。
JavaShellToolBuilder	in(InputStream cmdIn, InputStream userIn)	入力チャネルを設定します。
default JavaShellToolBuilder	interactiveTerminal(boolean terminal)	入力および出力は、ANSIのエスケープ・コードを解釈できる対話型端末に接続されるようにするには、trueに設定します。
JavaShellToolBuilder	locale(Locale locale)	ロケールを設定します。
JavaShellToolBuilder	out(PrintStream output)	出力チャネルを設定します。
JavaShellToolBuilder	out(PrintStream cmdOut, PrintStream console, PrintStream userOut)	出力チャネルを設定します。
JavaShellToolBuilder	persistence(Map<String,String> prefsMap)	入力履歴と保持された設定を含む永続的な情報のストレージ・メカニズムを設定します。
JavaShellToolBuilder	persistence(Preferences prefs)	入力履歴と保持された設定を含む永続的な情報のストレージ・メカニズムを設定します。
JavaShellToolBuilder	promptCapture(boolean capture)	プロンプトのオーバーライドを取得するコマンドを有効にするように設定します。
void	run(String... arguments)	このインタフェースの他のメソッドで構成されているように、Javaシェル・ツールのインスタンスを実行します。
default int	start(String... arguments)	このインタフェースの他のメソッドで構成されているように、Javaシェル・ツールのインスタンスを実行します。

メソッドの詳細

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 - ユーザー・コード出力の宛先。 たとえば、ユーザー・スニペットSystem.out.println("Hello")を実行すると、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 - ユーザー・コード・エラー出力の宛先。 たとえば、ユーザー・スニペットSystem.err.println("Oops")を実行すると、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コマンドで設定されます。

戻り値:

JavaShellToolBuilderインスタンス

interactiveTerminal

default JavaShellToolBuilder interactiveTerminal(boolean terminal)

入力および出力は、ANSIのエスケープ・コードを解釈できる対話型端末に接続されるようにするには、trueに設定します。 出力ストリームに送信される文字は端末によって解釈され、ユーザーに表示されます。出力に送信される文字の正確な順序と性質は不特定です。 出力を自動ツールで解析できる従来の単純な動作を指定するには、falseに設定します。 このJavaシェルの入力ストリームがSystem.inの場合、この値は無視され、このメソッドでのtrueの指定に似ていますが、System.inに接続されている特定の端末に厳密に続きます。

実装要件:

このメソッドが呼び出されない場合、動作はinteractiveTerminal(false)の呼出しと同じである必要があります。 このメソッドのデフォルト実装は、thisを返します。

パラメータ:

terminal - trueの場合、ANSIエスケープ・コードを解釈できる端末は、出力を解釈すると見なされます。 falseの場合、より単純な出力が選択されます。

戻り値:

JavaShellToolBuilderインスタンス

導入されたバージョン:

17

run

void run(String... arguments) throws Exception

このインタフェースの他のメソッドで構成されているように、Javaシェル・ツールのインスタンスを実行します。 このコールは破壊的ではありません。このメソッドの複数のコールは、構成されたビルダーから行うことができます。 Javaシェル・ツールの終了コードは無視されます。

パラメータ:

arguments - コマンドライン引数(オプションを含む)(存在する場合)

例外:

Exception - 予期しない致命的な例外

start

default int start(String... arguments) throws Exception

このインタフェースの他のメソッドで構成されているように、Javaシェル・ツールのインスタンスを実行します。 このコールは破壊的ではありません。このメソッドの複数のコールは、構成されたビルダーから行うことができます。

実装要件:

デフォルト実装は常にゼロを返します。 このインタフェースの実装は、このメソッドをオーバーライドして、終了ステータスを返します。

パラメータ:

arguments - コマンドライン引数(オプションを含む)(存在する場合)

戻り値:

ツールが明示的に(もしあれば)を終了した終了ステータス。成功した場合は0、失敗の場合は1

例外:

Exception - 予期しない致命的な例外