Google は、黒人コミュニティに対する人種平等の促進に取り組んでいます。取り組みを見る
このページは Cloud Translation API によって翻訳されました。
Switch to English

IRunUtil

public interface IRunUtil

com.android.tradefed.util.IRunUtil


時限操作とシステムコマンドを実行するためのインターフェイス。

概要

ネストされたクラス

enum IRunUtil.EnvPriority

特定の環境を設定するか設定解除するかを定義する列挙型。

interface IRunUtil.IRunnableResult

ブール状態を返す操作を非同期で実行するためのインターフェース。

パブリックメソッド

abstract void allowInterrupt (boolean allow)

現在のスレッドでの実行割り込みを許可/禁止します。

abstract void interrupt (Thread thread, String message)

指定されたスレッドで実行中または実行予定の実行操作を中断します。

abstract boolean isInterruptAllowed ()

RunUtilの割り込みステータスを提供します。

abstract Process runCmdInBackground (String... command)

システムコマンドを非同期で実行するヘルパーメソッド。

abstract Process runCmdInBackground ( command) runCmdInBackground ( command)

ERROR(/List)形式のコマンド引数を受け入れる代替のrunCmdInBackground(String)メソッド。

abstract Process runCmdInBackground ( command, OutputStream output) runCmdInBackground ( command, OutputStream output)

ERROR(/OutputStream)を指定してコマンドを実行すると、コマンドの出力が記録されます。

abstract boolean runEscalatingTimedRetry (long opTimeout, long initialPollInterval, long maxPollInterval, long maxTime, IRunUtil.IRunnableResult runnable)

操作が成功するまで、操作を複数回ブロックして実行します。

abstract boolean runFixedTimedRetry (long opTimeout, long pollInterval, long maxTime, IRunUtil.IRunnableResult runnable)

操作が成功するまで、操作を複数回ブロックして実行します。

abstract CommandStatus runTimed (long timeout, IRunUtil.IRunnableResult runnable, boolean logErrors)

操作をブロックして実行し、指定した時間より長くかかる場合は中止します。

abstract CommandResult runTimedCmd (long timeout, String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。

abstract CommandResult runTimedCmd (long timeout, OutputStream stdout, OutputStream stderr, String... command)

システムコマンドを実行し、指定した時間より長くかかる場合は中止し、指定した場合は出力をファイルにリダイレクトするヘルパーメソッド。

abstract CommandResult runTimedCmdRetry (long timeout, long retryInterval, int attempts, String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。

abstract CommandResult runTimedCmdSilently (long timeout, String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。

abstract CommandResult runTimedCmdSilentlyRetry (long timeout, long retryInterval, int attempts, String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。

abstract CommandResult runTimedCmdWithInput (long timeout, String input, command) runTimedCmdWithInput (long timeout, String input, command)

stdin入力を必要とするシステムコマンドを実行するヘルパーメソッド。指定した時間より長くかかる場合は中止します。

abstract CommandResult runTimedCmdWithInput (long timeout, String input, String... command)

stdin入力を必要とするシステムコマンドを実行するヘルパーメソッド。指定した時間より長くかかる場合は中止します。

abstract CommandResult runTimedCmdWithInputRedirect (long timeout, File inputRedirect, String... command)

ファイルからStdinをリダイレクトする必要があるシステムコマンドを実行し、指定した時間よりも時間がかかる場合は中止するヘルパーメソッド。

abstract boolean runTimedRetry (long opTimeout, long pollInterval, int attempts, IRunUtil.IRunnableResult runnable)

操作が成功するまで、操作を複数回ブロックして実行します。

abstract void setEnvVariable (String key, String value)

システムコマンドの実行時に使用する環境変数を設定します。

abstract void setEnvVariablePriority ( IRunUtil.EnvPriority priority)

プロセスを作成するときに、環境変数の設定を解除することが、設定するよりも優先されるかどうかを決定します。

abstract void setInterruptibleInFuture (Thread thread, long timeMs)

しばらく待ってから割り込み可能に設定します。

abstract void setRedirectStderrToStdout (boolean redirect)

システムコマンドの実行時に標準出力ストリームにリダイレクトするように標準エラーストリームを設定します。

abstract void setWorkingDir (File dir)

システムコマンドの作業ディレクトリを設定します。

abstract void sleep (long time)

例外を無視して、一定時間スリープするヘルパーメソッド。

abstract void unsetEnvVariable (String key)

環境変数を設定解除するため、システムコマンドはこの環境変数なしで実行されます。

パブリックメソッド

allowInterrupt

public abstract void allowInterrupt (boolean allow)

現在のスレッドでの実行割り込みを許可/禁止します。許可されている場合、現在のスレッドの実行操作は、 interrupt(Thread, String)メソッドを介して他のスレッドからinterrupt(Thread, String)できます。

パラメーター
allow boolean :現在のスレッドで実行割り込みを許可するかどうか。

割り込み

public abstract void interrupt (Thread thread, 
                String message)

指定されたスレッドで実行中または実行予定の実行操作を中断します。指定されたスレッドでの実行操作はRunInterruptedExceptionをスローしRunInterruptedException

パラメーター
message StringRunInterruptedExceptionのメッセージ。

isInterruptAllowed

public abstract boolean isInterruptAllowed ()

RunUtilの割り込みステータスを提供します。

戻り値
boolean Runを中断できる場合はtrue、それ以外の場合はfalse。

runCmdInBackground

public abstract Process runCmdInBackground (String... command)

システムコマンドを非同期で実行するヘルパーメソッド。

コマンドを起動するとすぐに戻ります。

パラメーター
command String :指定されたシステムコマンドとオプションでexecの引数

戻り値
Process 実行されたコマンドのProcess

投げる
コマンドの実行に失敗した場合

runCmdInBackground

public abstract Process runCmdInBackground ( command)

ERROR(/List)形式のコマンド引数を受け入れる代替のrunCmdInBackground(String)メソッド。

パラメーター
command :指定されたシステムコマンドとオプションでexecへの引数を含むERROR(/List)

戻り値
Process 実行されたコマンドのProcess

投げる
コマンドの実行に失敗した場合

runCmdInBackground

public abstract Process runCmdInBackground ( command, 
                OutputStream output)

ERROR(/OutputStream)を指定してコマンドを実行すると、コマンドの出力が記録されます。 stdoutとstderrは一緒にマージされます。

パラメーター
command :実行するコマンド

output OutputStream :出力を保存するためのOutputStream

戻り値
Process コマンドを実行しているProcess

runEscalatingTimedRetry

public abstract boolean runEscalatingTimedRetry (long opTimeout, 
                long initialPollInterval, 
                long maxPollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

操作が成功するまで、操作を複数回ブロックして実行します。

操作の試行間の待機時間を指数関数的に増やします。これは、サーバーのポーリングなどの操作を実行するときに使用して、サーバーが一時的にダウンした場合に回復する時間を与えることを目的としています。

パラメーター
opTimeout long :単一の操作試行を待機する最大時間(ミリ秒)

initialPollInterval long :操作の試行の間に待機する最初の時間

maxPollInterval long :操作の試行の間に待機する最大時間

maxTime long :操作を試行し続けるためのおおよその最大合計時間

runnable IRunUtil.IRunnableResult :実行するIRunUtil.IRunnableResult

戻り値
boolean maxTimeが期限切れになる前に操作が正常に完了した場合はtrue

runFixedTimedRetry

public abstract boolean runFixedTimedRetry (long opTimeout, 
                long pollInterval, 
                long maxTime, 
                IRunUtil.IRunnableResult runnable)

操作が成功するまで、操作を複数回ブロックして実行します。

パラメーター
opTimeout long :単一の操作試行を待機する最大時間(ミリ秒)

pollInterval long :操作の試行の間に待機する最初の時間

maxTime long :操作を試行し続けるためのおおよその最大合計時間

runnable IRunUtil.IRunnableResult :実行するIRunUtil.IRunnableResult

戻り値
boolean maxTimeが期限切れになる前に操作が正常に完了した場合はtrue

runTimed

public abstract CommandStatus runTimed (long timeout, 
                IRunUtil.IRunnableResult runnable, 
                boolean logErrors)

操作をブロックして実行し、指定した時間より長くかかる場合は中止します。

パラメーター
timeout long :待機する最大時間(ミリ秒)

runnable IRunUtil.IRunnableResult :実行するIRunUtil.IRunnableResult

logErrors boolean :例外の有無にかかわらずエラーを記録します。

戻り値
CommandStatus 操作のCommandStatus結果。

runTimedCmd

public abstract CommandResult runTimedCmd (long timeout, 
                String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。

パラメーター
timeout long :待機する最大時間(ミリ秒)。 0はタイムアウトがないことを意味します。

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmd

public abstract CommandResult runTimedCmd (long timeout, 
                OutputStream stdout, 
                OutputStream stderr, 
                String... command)

システムコマンドを実行し、指定した時間より長くかかる場合は中止し、指定した場合は出力をファイルにリダイレクトするヘルパーメソッド。 ERROR(/OutputStream)がこのように提供されると、関数の最後で開いたままになります。

パラメーター
timeout long :タイムアウトする最大待機時間(ミリ秒)。 0はタイムアウトがないことを意味します。

stdout OutputStreamERROR(/OutputStream) std出力がリダイレクトされます。 nullにすることができます。

stderr OutputStreamERROR(/OutputStream)エラー出力がリダイレクトされる場所。 nullにすることができます。

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmdRetry

public abstract CommandResult runTimedCmdRetry (long timeout, 
                long retryInterval, 
                int attempts, 
                String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。

パラメーター
timeout long :各試行をミリ秒で待機する最大時間

retryInterval long :コマンドの再試行の間に待機する時間

attempts int :試行する最大試行回数

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmdSilently

public abstract CommandResult runTimedCmdSilently (long timeout, 
                String... command)

システムコマンドを実行するヘルパーメソッド。指定した時間よりも長くかかる場合は中止します。 runTimedCmd(long, String)に似ていますが、例外時にエラーをログに記録しません。

パラメーター
timeout long :待機する最大時間(ミリ秒)

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmdSilentlyRetry

public abstract CommandResult runTimedCmdSilentlyRetry (long timeout, 
                long retryInterval, 
                int attempts, 
                String... command)

システムコマンドを実行するヘルパーメソッド。指定された時間より長くかかる場合は中止します。 runTimedCmdRetry(long, long, int, String[])に似ていますが、例外時にエラーをログに記録しません。

パラメーター
timeout long :待機する最大時間(ミリ秒)

retryInterval long :コマンドの再試行の間に待機する時間

attempts int :試行する最大試行回数

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmdWithInput

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                 command)

stdin入力を必要とするシステムコマンドを実行するヘルパーメソッド。指定した時間より長くかかる場合は中止します。

パラメーター
timeout long :待機する最大時間(ミリ秒)

input String :プロセスに渡す標準入力

command ERROR(/List)は、システムコマンドと、オプションでexecの引数が含まれています

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmdWithInput

public abstract CommandResult runTimedCmdWithInput (long timeout, 
                String input, 
                String... command)

stdin入力を必要とするシステムコマンドを実行するヘルパーメソッド。指定した時間より長くかかる場合は中止します。

パラメーター
timeout long :待機する最大時間(ミリ秒)

input String :プロセスに渡す標準入力

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedCmdWithInputRedirect

public abstract CommandResult runTimedCmdWithInputRedirect (long timeout, 
                File inputRedirect, 
                String... command)

Stdinをファイルからリダイレクトする必要があるシステムコマンドを実行し、指定した時間よりも時間がかかる場合は中止するヘルパーメソッド。

パラメーター
timeout long :待機する最大時間(ミリ秒)

inputRedirect FileERROR(/File)ProcessBuilder.redirectInput()を使用して標準入力としてリダイレクトします。 nullの場合、stdinはリダイレクトされません。

command String :指定されたシステムコマンドとオプションのexecへの引数

戻り値
CommandResult コマンド実行の結果を含むCommandResult

runTimedRetry

public abstract boolean runTimedRetry (long opTimeout, 
                long pollInterval, 
                int attempts, 
                IRunUtil.IRunnableResult runnable)

操作が成功するまで、操作を複数回ブロックして実行します。

パラメーター
opTimeout long :1つの操作の試行を待機する最大時間(ミリ秒)

pollInterval long :コマンドの再試行の間に待機する時間

attempts int :試行する最大試行回数

runnable IRunUtil.IRunnableResult :実行するIRunUtil.IRunnableResult

戻り値
boolean 試行回数に達する前に操作が正常に完了した場合はtrue

setEnvVariable

public abstract void setEnvVariable (String key, 
                String value)

システムコマンドの実行時に使用する環境変数を設定します。

パラメーター
key String :変数名

value String :変数値

以下も参照してください。

setEnvVariablePriority

public abstract void setEnvVariablePriority ( IRunUtil.EnvPriority priority)

プロセスを作成するときに、環境変数の設定を解除することが、設定するよりも優先されるかどうかを決定します。デフォルトでは、設定解除の方が優先度が高くなります。つまり、同じ名前の変数を設定しようとした場合、変数の設定が解除されるため、設定は行われません。デフォルトのIRunUtilインスタンスでは使用できません。

パラメーター
priority IRunUtil.EnvPriority

setInterruptibleInFuture

public abstract void setInterruptibleInFuture (Thread thread, 
                long timeMs)

しばらく待ってから割り込み可能に設定します。 CommandScheduler#shutdownHard()を使用して、最終的に強制終了します。

パラメーター
thread Thread :割り込み可能になるスレッド。

timeMs long :割り込み可能に設定する前に待機する時間。

setRedirectStderrToStdout

public abstract void setRedirectStderrToStdout (boolean redirect)

システムコマンドの実行時に標準出力ストリームにリダイレクトするように標準エラーストリームを設定します。初期値はfalseです。

パラメーター
redirect boolean :リダイレクトするかどうかの新しい値

以下も参照してください。

setWorkingDir

public abstract void setWorkingDir (File dir)

システムコマンドの作業ディレクトリを設定します。

パラメーター
dir File :作業ディレクトリ

以下も参照してください。

睡眠

public abstract void sleep (long time)

例外を無視して、一定時間スリープするヘルパーメソッド。

パラメーター
time long :スリープするミリ秒。 0以下の値は無視されます

unsetEnvVariable

public abstract void unsetEnvVariable (String key)

環境変数を設定解除するため、システムコマンドはこの環境変数なしで実行されます。

パラメーター
key String :変数名

以下も参照してください。