ProcessBuilder (Java Platform SE 7)

java.lang.Object
- java.lang.ProcessBuilder

```
public final class ProcessBuilder
extends Object
```
このクラスは、オペレーティングシステムのプロセスの作成に使用されます。
各 ProcessBuilder インスタンスは、プロセス属性のコレクションを管理します。start() メソッドはそれらの属性を使って新しい Process インスタンスを作成します。同じインスタンスから start() メソッドを繰り返し呼び出して、同一の属性または関連する属性を持つ新規サブプロセスを作成できます。
各プロセスビルダーは、次のプロセス属性を管理します。
- コマンド。呼び出される外部プログラムファイルと、その引数 (存在する場合) を示す文字列のリストです。どの文字列リストが有効なオペレーティングシステムコマンドを表すかは、システムに応じて異なります。たとえば、概念上の引数がリストの要素となるのが一般的ですが、プログラムがコマンド行文字列自体をトークン化することが要求されるオペレーティングシステムがあります。このようなシステムの Java 実装では、正確に 2 つの要素を含むコマンドが必要になる場合があります。
- 環境。環境は変数から値へのシステム依存のマッピングです。初期値は、現在のプロセスの環境のコピーです (System.getenv() を参照)。
- 作業ディレクトリ。デフォルト値は、現在のプロセスの現在の作業ディレクトリです。通常、このディレクトリはシステムプロパティー user.dir で名前が付けられたディレクトリです。
- 標準入力の入力元。デフォルトでは、サブプロセスはパイプから入力を読み取ります。Java コード内でこのパイプにアクセスするには、Process.getOutputStream() から返される出力ストリームを使用します。ただし標準入力は、redirectInput を使って別の入力元にリダイレクトできます。この場合、Process.getOutputStream() から次のような null 出力ストリームが返されます。
  - write メソッドは常に IOException をスローする
  - close メソッドは何も行わない
- 標準出力と標準エラーの出力先。デフォルトでは、サブプロセスは標準出力と標準エラーをパイプに書き込みます。Java コード内でこれらのパイプにアクセスするには、Process.getInputStream() および Process.getErrorStream() から返される入力ストリームを使用します。ただし標準出力や標準エラーは、redirectOutput や redirectError を使ってほかの出力先にリダイレクトできます。この場合、Process.getInputStream() または Process.getErrorStream()、あるいはその両方から、次のような null 入力ストリームが返されます。
  - read メソッドは常に -1 を返す
  - available メソッドは常に 0 を返す
  - close メソッドは何も行わない
- redirectErrorStream プロパティー。初期状態では、このプロパティーは false です。つまり、サブプロセスの標準出力とエラー出力は、2 つの独立したストリームに送信されます。これらの出力には Process.getInputStream() メソッドと Process.getErrorStream() メソッドを使ってアクセスできます。
  値が true に設定された場合:
  - 標準エラーが標準出力にマージされ、両者が常に同じ出力先に送信される (この場合、エラーメッセージと対応する出力との相関関係が把握しやすくなる)
  - 標準エラーと標準出力の共通の出力先をリダイレクトするには、redirectOutput を使用する
  - サブプロセスの作成時に、redirectError メソッドで設定されたリダイレクトは無視される
  - Process.getErrorStream() から返されるストリームは常に null 入力ストリームとなる
プロセスビルダーの属性を変更すると、属性を変更したオブジェクトの start() メソッドでそれ以降起動されるプロセスに影響がありますが、それ以前に起動されたプロセスや Java プロセス自体には影響ありません。
ほとんどのエラーチェックは start() メソッドで実行されます。start() が失敗するように、オブジェクトの状態を変更できます。たとえば、コマンド属性を空のリストに設定すると、start() が呼び出されない限り、例外はスローされません。
このクラスは同期化されません。複数のスレッドが ProcessBuilder インスタンスに並行してアクセスし、少なくとも 1 つのスレッドが構造的に 1 つの属性を変更した場合、変更された属性は外部で同期化されなければいけません。
デフォルトの作業ディレクトリと環境を使用する新しいプロセスを起動するのは、次に示すように容易です。
```
 Process p = new ProcessBuilder("myCommand", "myArg").start();
 
```
変更された作業ディレクトリと環境を使ってプロセスを起動し、標準出力と標準エラーがログファイルに追加されるようにリダイレクトする例を、次に示します。
```
 ProcessBuilder pb =
   new ProcessBuilder("myCommand", "myArg1", "myArg2");
 Map<String, String> env = pb.environment();
 env.put("VAR1", "myValue");
 env.remove("OTHERVAR");
 env.put("VAR2", env.get("VAR1") + "suffix");
 pb.directory(new File("myDir"));
 File log = new File("log");
 pb.redirectErrorStream(true);
 pb.redirectOutput(Redirect.appendTo(log));
 Process p = pb.start();
 assert pb.redirectInput() == Redirect.PIPE;
 assert pb.redirectOutput().file() == log;
 assert p.getInputStream().read() == -1;
 
```
環境変数の明示的セットを持つプロセスを起動するには、まず Map.clear() を呼び出してから、環境変数を追加します。
導入されたバージョン:

1.5

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型クラスと説明

static class ProcessBuilder.Redirect
サブプロセスの入力元またはサブプロセスの出力先を表します。

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`ProcessBuilder.Redirect` サブプロセスの入力元またはサブプロセスの出力先を表します。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`ProcessBuilder(List<String> command)` 指定されたオペレーティングシステムプログラムと引数を持つプロセスビルダーを構築します。
`ProcessBuilder(String... command)` 指定されたオペレーティングシステムプログラムと引数を持つプロセスビルダーを構築します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`List<String>`	`command()` プロセスビルダーのオペレーティングシステムプログラムと引数を返します。
`ProcessBuilder`	`command(List<String> command)` このプロセスビルダーのオペレーティングシステムプログラムと引数を設定します。
`ProcessBuilder`	`command(String... command)` このプロセスビルダーのオペレーティングシステムプログラムと引数を設定します。
`File`	`directory()` このプロセスビルダーの作業ディレクトリを返します。
`ProcessBuilder`	`directory(File directory)` このプロセスビルダーの作業ディレクトリを設定します。
`Map<String,String>`	`environment()` このプロセスビルダーの環境の文字列マップのビューを返します。
`ProcessBuilder`	`inheritIO()` サブプロセスの標準入出力の入力元と出力先を、現在の Java プロセスと同じものに設定します。
`ProcessBuilder.Redirect`	`redirectError()` このプロセスビルダーの標準エラー出力先を返します。
`ProcessBuilder`	`redirectError(File file)` このプロセスビルダーの標準エラー出力先をファイルに設定します。
`ProcessBuilder`	`redirectError(ProcessBuilder.Redirect destination)` このプロセスビルダーの標準エラー出力先を設定します。
`boolean`	`redirectErrorStream()` このプロセスビルダーが標準エラーと標準出力をマージするかどうかを判定します。
`ProcessBuilder`	`redirectErrorStream(boolean redirectErrorStream)` このプロセスビルダーの `redirectErrorStream` プロパティーを設定します。
`ProcessBuilder.Redirect`	`redirectInput()` このプロセスビルダーの標準入力元を返します。
`ProcessBuilder`	`redirectInput(File file)` このプロセスビルダーの標準入力元をファイルに設定します。
`ProcessBuilder`	`redirectInput(ProcessBuilder.Redirect source)` このプロセスビルダーの標準入力元を設定します。
`ProcessBuilder.Redirect`	`redirectOutput()` このプロセスビルダーの標準出力先を返します。
`ProcessBuilder`	`redirectOutput(File file)` このプロセスビルダーの標準出力先をファイルに設定します。
`ProcessBuilder`	`redirectOutput(ProcessBuilder.Redirect destination)` このプロセスビルダーの標準出力先を設定します。
`Process`	`start()` このプロセスビルダーの属性を使って新規プロセスを起動します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ProcessBuilder
```
public ProcessBuilder(List<String> command)
```
    指定されたオペレーティングシステムプログラムと引数を持つプロセスビルダーを構築します。このコンストラクタは、command リストのコピーを作成しません。以降のリストの更新は、プロセスビルダーの状態に反映されます。command が有効なオペレーティングシステムコマンドに対応するかどうかはチェックされません。
    
    パラメータ:
    command - プログラムとプログラムの引数を含むリスト
    
    例外:
    
    NullPointerException - 引数が null の場合
  - ProcessBuilder
```
public ProcessBuilder(String... command)
```
    指定されたオペレーティングシステムプログラムと引数を持つプロセスビルダーを構築します。このコンストラクタは、command 配列と同じ文字列を含む文字列リストに、プロセスビルダーのコマンドを同じ順序で設定する簡易コンストラクタです。command が有効なオペレーティングシステムコマンドに対応するかどうかはチェックされません。
    
    パラメータ:
    command - プログラムとプログラムの引数を含む文字列配列
- メソッドの詳細
  - command
```
public ProcessBuilder command(List<String> command)
```
    このプロセスビルダーのオペレーティングシステムプログラムと引数を設定します。このメソッドは、command リストのコピーを作成しません。以降のリストの更新は、プロセスビルダーの状態に反映されます。command が有効なオペレーティングシステムコマンドに対応するかどうかはチェックされません。
    
    パラメータ:
    command - プログラムとプログラムの引数を含むリスト
    
    戻り値:
    このプロセスビルダー
    
    例外:
    
    NullPointerException - 引数が null の場合
  - command
```
public ProcessBuilder command(String... command)
```
    このプロセスビルダーのオペレーティングシステムプログラムと引数を設定します。このコンストラクタは、command 配列と同じ文字列を含む文字列リストにコマンドを同じ順序で設定する簡易メソッドです。command が有効なオペレーティングシステムコマンドに対応するかどうかはチェックされません。
    
    パラメータ:
    command - プログラムとプログラムの引数を含む文字列配列
    
    戻り値:
    このプロセスビルダー
  - command
```
public List<String> command()
```
    プロセスビルダーのオペレーティングシステムプログラムと引数を返します。返されたリストはコピーではありません。以降のリストの更新は、プロセスビルダーの状態に反映されます。
    
    戻り値:
    このプロセスビルダーのプログラムとプログラムの引数
  - environment
```
public Map<String,String> environment()
```
    このプロセスビルダーの環境の文字列マップのビューを返します。プロセスビルダーが作成されるたびに、環境は現在のプロセス環境のコピーに初期化されます (System.getenv() を参照)。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、このマップを環境として使用します。
    返されたオブジェクトは、通常の Map オペレーションを使って変更できます。これらの変更は、start() メソッドを使って起動されたサブプロセスで可視です。2 つの ProcessBuilder インスタンスは常に独立したプロセス環境を持っています。このため、返されたマップは、ほかの ProcessBuilder インスタンスや、System.getenv で返された値に反映されることはありません。
    システムが環境変数をサポートしていない場合は、空のマップが返されます。
    返されたマップは、null のキーや値を許容しません。null のキーや値を挿入したり、これらがあるか照会すると、NullPointerException がスローされます。String 以外の型のキーや値が存在するかどうかのクエリーを試みると、ClassCastException がスローされます。
    返されたマップの動作はシステムに依存します。環境変数の変更を許可しないシステムがあれば、特定の変数名や値が禁止されるシステムもあります。この理由から、オペレーティングシステムで変更が許可されていない場合にマップを変更しようとすると、UnsupportedOperationException や IllegalArgumentException で失敗する可能性があります。
    環境変数名と環境変数の値の外部形式はシステムに依存するので、環境変数名と環境変数の値と Java の Unicode 文字列との間に 1 対 1 のマッピング関係がない可能性があります。その場合でも、Java コードで変更されていない環境変数が、サブプロセスでも変更されていないネイティブな表現を持つようにマップは実装されます。
    返されたマップとそのコレクションビューは、Object.equals(java.lang.Object) メソッドと Object.hashCode() メソッドの汎用規約に従わない可能性があります。
    返されたマップは、一般にすべてのプラットフォームで大文字と小文字を区別します。
    セキュリティーマネージャーが存在する場合は、その checkPermission メソッドが RuntimePermission("getenv.*") アクセス権で呼び出されます。これにより、SecurityException がスローされる可能性があります。
    Java サブプロセスに情報を渡す場合、一般的に環境変数よりもシステムプロパティーが推奨されます。
    
    戻り値:
    このプロセスビルダーの環境
    
    例外:
    
    SecurityException - セキュリティーマネージャーが存在し、その checkPermission メソッドがプロセス環境へのアクセスを許可しない場合
    関連項目:
    Runtime.exec(String[],String[],java.io.File), System.getenv()
  - directory
```
public File directory()
```
    このプロセスビルダーの作業ディレクトリを返します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、このディレクトリを作業ディレクトリとして使用します。戻り値は、null の可能性があります。これは、現在の Java プロセスの作業ディレクトリ (通常は user.dir システムプロパティーで指定されたディレクトリ) を子プロセスの作業ディレクトリとして使用することを意味します。
    
    戻り値:
    このプロセスビルダーの作業ディレクトリ
  - directory
```
public ProcessBuilder directory(File directory)
```
    このプロセスビルダーの作業ディレクトリを設定します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、このディレクトリを作業ディレクトリとして使用します。引数は、null の可能性があります。これは、現在の Java プロセスの作業ディレクトリ (通常は user.dir システムプロパティーで指定されたディレクトリ) を子プロセスの作業ディレクトリとして使用することを意味します。
    
    パラメータ:
    directory - 新規作業ディレクトリ
    
    戻り値:
    このプロセスビルダー
  - redirectInput
```
public ProcessBuilder redirectInput(ProcessBuilder.Redirect source)
```
    このプロセスビルダーの標準入力元を設定します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、標準入力をこの入力元から取得します。
    source が Redirect.PIPE (初期値) の場合、Process.getOutputStream() から返される出力ストリームを使ってサブプロセスの標準入力への書き込みを行えます。source をその他の値に設定した場合、Process.getOutputStream() から null 出力ストリームが返されます。
    
    パラメータ:
    source - 新しい標準入力元
    
    戻り値:
    このプロセスビルダー
    
    例外:
    
    IllegalArgumentException - リダイレクトがデータの有効な出力先に対応していない場合、つまりその型が WRITE または APPEND の場合
    導入されたバージョン:
    
    1.7
  - redirectOutput
```
public ProcessBuilder redirectOutput(ProcessBuilder.Redirect destination)
```
    このプロセスビルダーの標準出力先を設定します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、標準出力をこの出力先に送信します。
    destination が Redirect.PIPE (初期値) の場合、Process.getInputStream() から返される入力ストリームを使ってサブプロセスの標準出力の読み取りを行えます。destination をその他の値に設定した場合、Process.getInputStream() から null 入力ストリームが返されます。
    
    パラメータ:
    destination - 新しい標準出力先
    
    戻り値:
    このプロセスビルダー
    
    例外:
    
    IllegalArgumentException - リダイレクトがデータの有効な出力先に対応していない場合、つまり次の型を持つ場合: READ
    導入されたバージョン:
    
    1.7
  - redirectError
```
public ProcessBuilder redirectError(ProcessBuilder.Redirect destination)
```
    このプロセスビルダーの標準エラー出力先を設定します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、標準エラーをこの出力先に送信します。
    destination が Redirect.PIPE (初期値) の場合、Process.getErrorStream() から返される入力ストリームを使ってサブプロセスのエラー出力の読み取りを行えます。destination をその他の値に設定した場合、Process.getErrorStream() から null 入力ストリームが返されます。
    redirectErrorStream 属性が true に設定されていた場合、このメソッドで設定されたリダイレクトは何の効果も持ちません。
    
    パラメータ:
    destination - 新しい標準エラー出力先
    
    戻り値:
    このプロセスビルダー
    
    例外:
    
    IllegalArgumentException - リダイレクトがデータの有効な出力先に対応していない場合、つまり次の型を持つ場合: READ
    導入されたバージョン:
    
    1.7
  - redirectInput
```
public ProcessBuilder redirectInput(File file)
```
    このプロセスビルダーの標準入力元をファイルに設定します。
    これは、簡易メソッドです。redirectInput(file) の形式で呼び出した場合、呼び出し redirectInput (Redirect.from(file)) とまったく同じ動作になります。
    
    パラメータ:
    file - 新しい標準入力元
    
    戻り値:
    このプロセスビルダー
    導入されたバージョン:
    
    1.7
  - redirectOutput
```
public ProcessBuilder redirectOutput(File file)
```
    このプロセスビルダーの標準出力先をファイルに設定します。
    これは、簡易メソッドです。redirectOutput(file) の形式で呼び出した場合、呼び出し redirectOutput (Redirect.to(file)) とまったく同じ動作になります。
    
    パラメータ:
    file - 新しい標準出力先
    
    戻り値:
    このプロセスビルダー
    導入されたバージョン:
    
    1.7
  - redirectError
```
public ProcessBuilder redirectError(File file)
```
    このプロセスビルダーの標準エラー出力先をファイルに設定します。
    これは、簡易メソッドです。redirectError(file) の形式で呼び出した場合、呼び出し redirectError (Redirect.to(file)) とまったく同じ動作になります。
    
    パラメータ:
    file - 新しい標準エラー出力先
    
    戻り値:
    このプロセスビルダー
    導入されたバージョン:
    
    1.7
  - redirectInput
```
public ProcessBuilder.Redirect redirectInput()
```
    このプロセスビルダーの標準入力元を返します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、標準入力をこの入力元から取得します。初期値は Redirect.PIPE です。
    
    戻り値:
    このプロセスビルダーの標準入力元
    導入されたバージョン:
    
    1.7
  - redirectOutput
```
public ProcessBuilder.Redirect redirectOutput()
```
    このプロセスビルダーの標準出力先を返します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、標準出力をこの出力先にリダイレクトします。初期値は Redirect.PIPE です。
    
    戻り値:
    このプロセスビルダーの標準出力先
    導入されたバージョン:
    
    1.7
  - redirectError
```
public ProcessBuilder.Redirect redirectError()
```
    このプロセスビルダーの標準エラー出力先を返します。これ以降、このオブジェクトの start() メソッドで起動されたサブプロセスは、標準エラーをこの出力先にリダイレクトします。初期値は Redirect.PIPE です。
    
    戻り値:
    このプロセスビルダーの標準エラー出力先
    導入されたバージョン:
    
    1.7
  - inheritIO
```
public ProcessBuilder inheritIO()
```
    サブプロセスの標準入出力の入力元と出力先を、現在の Java プロセスと同じものに設定します。
    これは、簡易メソッドです。次の形式の呼び出しは、
```
 pb.inheritIO()
 
```
    次の呼び出しと正確に同じ動作になります。
```
 pb.redirectInput(Redirect.INHERIT)
   .redirectOutput(Redirect.INHERIT)
   .redirectError(Redirect.INHERIT)
 
```
    この動作は、ほとんどのオペレーティングシステムコマンドインタプリタや標準 C ライブラリ関数 system() と同等のものになります。
    戻り値:
    このプロセスビルダー
    導入されたバージョン:
    
    1.7
  - redirectErrorStream
```
public boolean redirectErrorStream()
```
    このプロセスビルダーが標準エラーと標準出力をマージするかどうかを判定します。
    このプロパティーが true の場合、このオブジェクトの start() メソッドでそれ以降起動されたサブプロセスにより生成されるエラー出力は、標準出力とマージされます。これにより、Process.getInputStream() メソッドを使って、エラー出力と標準出力の両方を読み取ることができます。マージにより、エラーメッセージと対応する出力との相関を示すのが容易になります。初期値は false です。
    
    戻り値:
    このプロセスビルダーの redirectErrorStream プロパティー
  - redirectErrorStream
```
public ProcessBuilder redirectErrorStream(boolean redirectErrorStream)
```
    このプロセスビルダーの redirectErrorStream プロパティーを設定します。
    このプロパティーが true の場合、このオブジェクトの start() メソッドでそれ以降起動されたサブプロセスにより生成されるエラー出力は、標準出力とマージされます。これにより、Process.getInputStream() メソッドを使って、エラー出力と標準出力の両方を読み取ることができます。マージにより、エラーメッセージと対応する出力との相関を示すのが容易になります。初期値は false です。
    
    パラメータ:
    redirectErrorStream - 新しいプロパティーの値
    
    戻り値:
    このプロセスビルダー
  - start
```
public Process start()
              throws IOException
```
    このプロセスビルダーの属性を使って新規プロセスを起動します。
    新しいプロセスは、directory() で与えられる作業ディレクトリ内で、environment() で与えられるプロセス環境の下、command() で与えられるコマンドと引数を呼び出します。
    このメソッドは、コマンドが有効なオペレーティングシステムコマンドであることをチェックします。どのコマンドが有効かはシステム依存ですが、コマンドは少なくとも null 以外の文字列の空でないリストである必要があります。
    一部のオペレーティングシステムでは、プロセスを起動するために最小限のシステム依存環境変数のセットが必要となる可能性があります。このため、プロセスビルダーの environment() に含まれていない追加の環境変数設定をサブプロセスが継承する可能性があります。
    セキュリティーマネージャーが存在する場合はその checkExec メソッドが呼び出されますが、その際、このオブジェクトの command 配列の最初のコンポーネントが引数として指定されます。これにより、SecurityException がスローされる可能性があります。
    オペレーティングシステムプロセスの起動はきわめてシステムに依存します。発生する可能性がある不具合は次のとおりです。
    - オペレーティングシステムプログラムファイルが見つからなかった。
    - プログラムファイルへのアクセス権が拒否された。
    - 作業ディレクトリが存在しない。
    以上のケースでは、例外がスローされます。例外の正確な特性はシステムに依存しますが、これは常に IOException のサブクラスになります。
    このプロセスビルダーへの以降の変更は、返された Process に影響を及ぼしません。
    戻り値:
    サブプロセス管理用の新しい Process オブジェクト
    
    例外:
    
    NullPointerException - コマンドリストの要素が null の場合
    
    IndexOutOfBoundsException - コマンドが空 (サイズが 0) のリストの場合
    SecurityException - セキュリティーマネージャーが存在していて、
    
    その checkExec メソッドがサブプロセスの作成を許可しない場合、または
    サブプロセスの標準入力がファイルからの読み取りにリダイレクトされていて、セキュリティーマネージャーの checkRead メソッドがファイルからの読み取りアクセスを拒否する場合、または
    サブプロセスの標準出力または標準エラーがファイルにリダイレクトされていて、セキュリティーマネージャーの checkWrite メソッドがファイルへの書き込みアクセスを拒否する場合
    IOException - 入出力エラーが発生した場合
    関連項目:
    Runtime.exec(String[], String[], java.io.File)

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス ProcessBuilder

ネストされたクラスのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

コンストラクタの詳細

ProcessBuilder

ProcessBuilder

メソッドの詳細

command

command

command

environment

directory

directory

redirectInput

redirectOutput

redirectError

redirectInput

redirectOutput

redirectError

redirectInput

redirectOutput

redirectError

inheritIO

redirectErrorStream

redirectErrorStream

start