hiProcess (OtsuLibrary)

java.lang.Object
- otsu.hiNote.hiProcess

```
public class hiProcess
extends Object
```
外部コマンド実行機(試験中).
Processを用いて外部コマンドを実行します。

実行終了は次の形で知ることができます。
- 終了を同期式に待つ
- 非同期で動作させ、状態をポーリングする
- 非同期で動作させ、同期QUEUEで終了イベントを取得する
- 本クラスの派生を作りdone()関数で待つ
コマンドの標準出力と標準エラーは次の取り扱いができます。
- まとめて標準エラーに出力する
- 本クラスの派生を作り、output()関数で取得する
- ArrayList<String>に取りまとめる
- 同期QUEUE(hiSyncQue<String>)に流す
```
    ArrayList<String> lines  = new ArrayList<String>();
    hiProcess         process= new hiProcess();
    int               result = process.exec_start("dir",lines);
```

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`hiSyncQue<String>`	`err` 標準エラー出力取得用同期QUEUE(未)
`hiSyncQue<String>`	`out` 標準出力取得用同期QUEUE(初期値null)
`hiSyncQue<hiProcess>`	`sync` 終了イベント取得用同期QUEUE.

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

コンストラクタ
コンストラクタと説明

hiProcess()
構築子

hiProcess(hiSyncQue<String> outQue_)
構築子

コンストラクタ
コンストラクタと説明
`hiProcess()` 構築子
`hiProcess(hiSyncQue<String> outQue_)` 構築子

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`cd(String dir_)` ディレクトリを変更する.
`void`	`cmd_start(String cmd_)` コマンド行を指定し、非同期実行する.
`void`	`cmd_start(String[] cmd_)` コマンド要素を指定し、非同期実行する.
`int`	`cmd_start(String[] cmd_, ArrayList<String> result_)` コマンド要素を指定し、非同期実行し結果をえる.
`int`	`cmd_start(String cmd_, ArrayList<String> result_)` コマンド行を指定し、非同期実行し結果をえるここで指定されたコマンド文字列は cmd /c の後ろに付加され実行されます。
`void`	`cmd(String cmd_)` 実行すべきWindowsコマンド行を設定する.
`void`	`cmd(String[] cmd_)` 実行すべきWindowsコマンド要素並びを設定する.
`void`	`done(Exception e_)` 終了通知.
`void`	`done(int status_)` 終了通知.
`void`	`errout(String str_)` 非推奨です。現版では用いられていない。結果を得たい場合は`output(String)`をオーバーロードすること。
`void`	`exec_start(String cmd_)` コマンド行を指定し、非同期実行する.
`void`	`exec_start(String[] cmd_)` コマンド要素を指定し、非同期実行する.
`int`	`exec_start(String[] cmd_, ArrayList<String> result_)` コマンド要素を指定し、実行し、結果をえる.
`int`	`exec_start(String cmd_, ArrayList<String> result_)` コマンド行を指定し、非同期実行する.
`void`	`exec(String cmd_)` 実行すべきコマンド行を設定する.
`void`	`exec(String[] cmd_)` 実行すべきコマンド要素並びを設定する.
`boolean`	`is_running()` 実行中かどうかを調べる.
`boolean`	`output(String str_)` 標準out行ごとに呼び出される.
`void`	`removeEnv(String name_)` 実行時の環境変数を削除する.
`void`	`setEnv(String name_, String value_)` 実行時の環境変数をセットする.
`void`	`setOutputQue(hiSyncQue<String> outQue_)` 利用者指定の標準出力取得用同期QUEUEをセットする.
`void`	`setOutputQue(int limit_)` 指定サイズの標準出力取得用同期QUEUEをセットする.
`void`	`start()` 設定されたコマンドを非同期実行する.
`void`	`stop(boolean join_)` コマンドを停止する.
`void`	`waitAt(hiSyncQue<hiProcess> syncQue_)` 利用者指定の同期QUEUEを終了イベント待ち用にセット.
`int`	`waitFor()` 完了を待つ.
`int`	`waitFor(ArrayList<String> result_)` 完了を待つ；結果をリストに得る（試験中）.
`int`	`waitFor(long timeout_)` 完了を待つ;タイムアウト時コマンド停止.

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

- フィールドの詳細
  - sync
```
public hiSyncQue<hiProcess> sync
```
    終了イベント取得用同期QUEUE.
  - out
```
public hiSyncQue<String> out
```
    標準出力取得用同期QUEUE(初期値null)
  - err
```
public hiSyncQue<String> err
```
    標準エラー出力取得用同期QUEUE(未)
- コンストラクタの詳細
  - hiProcess
```
public hiProcess()
```
    構築子
  - hiProcess
```
public hiProcess(hiSyncQue<String> outQue_)
```
    構築子
    
    パラメータ:
    
    outQue_ - 出力QUEUE
- メソッドの詳細
  - waitAt
```
public void waitAt(hiSyncQue<hiProcess> syncQue_)
```
    利用者指定の同期QUEUEを終了イベント待ち用にセット.
    
    パラメータ:
    
    syncQue_ - 同期QUEUE
  - setOutputQue
```
public void setOutputQue(hiSyncQue<String> outQue_)
```
    利用者指定の標準出力取得用同期QUEUEをセットする.
    
    パラメータ:
    
    outQue_ - 標準出力取得用同期QUEUE
  - setOutputQue
```
public void setOutputQue(int limit_)
```
    指定サイズの標準出力取得用同期QUEUEをセットする.
    
    パラメータ:
    
    limit_ - queueサイズ
  - cd
```
public void cd(String dir_)
```
    ディレクトリを変更する.
    この変更はstart時に反映されます。
    実行中に行うと例外を発行します。
    
    パラメータ:
    
    dir_ - ディレクトリ
  - setEnv
```
public void setEnv(String name_,
                   String value_)
```
    実行時の環境変数をセットする. start時に反映されます。
    
    パラメータ:
    
    name_ - 環境変数名
    
    value_ - 値
  - removeEnv
```
public void removeEnv(String name_)
```
    実行時の環境変数を削除する. start時に反映されます。
    
    パラメータ:
    
    name_ - 環境変数名
  - cmd
```
public void cmd(String cmd_)
```
    実行すべきWindowsコマンド行を設定する.
    ここで指定されたコマンド行は
    cmd /c
    の後ろに付加されstartで実行されます
    
    パラメータ:
    
    cmd_ - コマンド文字列
  - cmd
```
public void cmd(String[] cmd_)
```
    実行すべきWindowsコマンド要素並びを設定する.
    ここで指定されたコマンド要素並びは
    cmd /c
    の後ろに付加されstartで実行されます
    
    パラメータ:
    
    cmd_ - コマンド文字列並び
  - cmd_start
```
public void cmd_start(String cmd_)
```
    コマンド行を指定し、非同期実行する.
    ここで指定されたコマンド文字列は
    cmd /c
    の後ろに付加され実行されます。
    
    パラメータ:
    
    cmd_ - コマンド文字列
  - cmd_start
```
public int cmd_start(String cmd_,
                     ArrayList<String> result_)
```
    コマンド行を指定し、非同期実行し結果をえる
    ここで指定されたコマンド文字列は
    cmd /c
    の後ろに付加され実行されます。
    
    パラメータ:
    
    cmd_ - コマンド文字列
    
    result_ - 結果
    
    戻り値:
    
    終了コード
  - cmd_start
```
public void cmd_start(String[] cmd_)
```
    コマンド要素を指定し、非同期実行する.
    ここで指定されたコマンド要素並びは
    cmd /c
    の後ろに付加され実行されます。
    
    パラメータ:
    
    cmd_ - コマンド文字列
  - cmd_start
```
public int cmd_start(String[] cmd_,
                     ArrayList<String> result_)
```
    コマンド要素を指定し、非同期実行し結果をえる.
    ここで指定されたコマンド要素並びは
    cmd /c
    の後ろに付加され実行されます。
    
    パラメータ:
    
    cmd_ - コマンド要素並び
    
    result_ - 結果
    
    戻り値:
    
    終了コード
  - exec
```
public void exec(String cmd_)
```
    実行すべきコマンド行を設定する.
    
    パラメータ:
    
    cmd_ - コマンド文字列
  - exec
```
public void exec(String[] cmd_)
```
    実行すべきコマンド要素並びを設定する.
    ここで指定されたコマンド要素並びで実行されます。コマンドの設定だけで、実行はstart()で行います。
    
    パラメータ:
    
    cmd_ - コマンド文字列並び
  - exec_start
```
public void exec_start(String cmd_)
```
    コマンド行を指定し、非同期実行する.
    
    パラメータ:
    
    cmd_ - コマンド文字列
  - exec_start
```
public int exec_start(String cmd_,
                      ArrayList<String> result_)
```
    コマンド行を指定し、非同期実行する.
    
    パラメータ:
    
    cmd_ - コマンド文字列
    
    result_ - 結果
    
    戻り値:
    
    終了コード
  - exec_start
```
public void exec_start(String[] cmd_)
```
    コマンド要素を指定し、非同期実行する.
    
    パラメータ:
    
    cmd_ - コマンド文字列並び
  - exec_start
```
public int exec_start(String[] cmd_,
                      ArrayList<String> result_)
```
    コマンド要素を指定し、実行し、結果をえる.
    
    パラメータ:
    
    cmd_ - コマンド文字列並び
    
    result_ - 結果
    
    戻り値:
    
    終了コード
  - start
```
public void start()
```
    設定されたコマンドを非同期実行する.
    cmd(String),cmd(String[]),exec(String),exec(String[]) で設定されたコマンドを非同期実行します。
    
    コマンド終了
  - is_running
```
public boolean is_running()
```
    実行中かどうかを調べる.
    
    戻り値:
    
    真:実行中,偽:実行中ではない
  - waitFor
```
public int waitFor()
```
    完了を待つ.
    
    戻り値:
    
    完了ステータス
  - waitFor
```
public int waitFor(ArrayList<String> result_)
```
    完了を待つ；結果をリストに得る（試験中）.
    
    パラメータ:
    
    result_ - ここに結果を得る（未）
    
    戻り値:
    
    完了ステータス
  - waitFor
```
public int waitFor(long timeout_)
```
    完了を待つ;タイムアウト時コマンド停止.
    完了を待ちます。
    タイムアウト時はコマンドプロセスを終了させます。
    同期QUEUEを用いたsync.waitFor()ではタイムアウト時にコマンドプロセスを終了させません。
    
    パラメータ:
    
    timeout_ - タイムアウト時間をミリ秒で指定
    
    戻り値:
    
    完了ステータス（-1:タイムアウト)
  - output
```
public boolean output(String str_)
```
    標準out行ごとに呼び出される.
    利用者はsetOutput()を用いて、QUEUEによる通知を受けることもできるが、このメソッドをオーバーロードしてもよい。
    
    パラメータ:
    
    str_ - 標準出力（+標準エラー出力）行
    
    戻り値:
    
    true:続行、false:終了
  - errout
```
public void errout(String str_)
```
    非推奨です。現版では用いられていない。結果を得たい場合はoutput(String)をオーバーロードすること。
    
    現版では用いられない
    
    パラメータ:
    
    str_ - メッセージ
  - done
```
public void done(int status_)
```
    終了通知.
    終了ステータスを記憶した上で、同期QUEUE（sync）に通知を出す。
    
    終了イベントは同期QUEUE（sync）で待つこともできるがこのメソッドをオーバーロードしてもよい
    
    パラメータ:
    
    status_ - 終了ステータス
  - done
```
public void done(Exception e_)
```
    終了通知.
    終了ステータス-2を記憶した上で、同期QUEUE（sync）に通知を出す。
    
    終了イベントは同期QUEUE（sync）で待つこともできるがこのメソッドをオーバーロードしてもよい
    
    パラメータ:
    
    e_ - 例外(内容は無視される)
  - stop
```
public void stop(boolean join_)
```
    コマンドを停止する.
    
    パラメータ:
    
    join_ - プロセス終了を待つ

クラス hiProcess

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

sync

out

err

コンストラクタの詳細

hiProcess

hiProcess

メソッドの詳細

waitAt

setOutputQue

setOutputQue

cd

setEnv

removeEnv

cmd

cmd

cmd_start

cmd_start

cmd_start

cmd_start

exec

exec

exec_start

exec_start

exec_start

exec_start

start

is_running

waitFor

waitFor

waitFor

output

errout

done

done

stop