IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


IConfigurationを作成するためのファクトリー

まとめ

パブリックメソッド

abstract IConfiguration createConfigurationFromArgs (String[] args, unconsumedArgs) createConfigurationFromArgs (String[] args, unconsumedArgs)

コマンドライン引数からIConfigurationを作成します。

abstract IConfiguration createConfigurationFromArgs (String[] args)

nullの 2 番目の引数をERROR(/#createConfigurationFromArgs(String[],List))を呼び出す便利なメソッド。

abstract IConfiguration createConfigurationFromArgs (String[] args, unconsumedArgs, IKeyStoreClient keyStoreClient) createConfigurationFromArgs (String[] args, unconsumedArgs, IKeyStoreClient keyStoreClient)

キー ストアを使用してコマンド ライン引数からIConfigurationを作成します。

abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, nonGlobalArgs) createGlobalConfigurationFromArgs (String[] args, nonGlobalArgs)

コマンド ライン引数からIGlobalConfigurationを作成します。

abstract IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator)

選択したオブジェクトのセットのみを含む構成を作成します。

abstract void dumpConfig (String configName, PrintStream out)

設定の内容を指定されたERROR(/PrintStream)にダンプします。

abstract getConfigList ()

クラスパス上の JAR で見つかったすべての構成の名前のリストを返します。

abstract getConfigList (String subPath, boolean loadFromEnv)

getConfigList()のバリエーションで、環境から構成をロードするかどうかを指定できます。

abstract void printHelp (PrintStream out)

このファクトリのヘルプ出力を印刷します。

abstract void printHelpForConfig (String[] args, boolean importantOnly, PrintStream out)

コマンド ライン引数で指定されたIConfigurationのヘルプ出力を出力します。

「args」が既知の構成を参照している場合、XML からIConfigurationオブジェクトが作成され、そのIConfigurationのヘルプが出力されます。

パブリックメソッド

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                 unconsumedArgs)

コマンドライン引数からIConfigurationを作成します。

予期される形式は「CONFIG [options]」です。ここで、CONFIG は、組み込みの構成名または構成 XML ファイルへのファイル パスです。

パラメーター
args String : コマンドライン引数

unconsumedArgs : 指定された構成に関連付けられたオブジェクトによって消費されなかった引数が設定されるリスト。これがnullの場合、未処理の引数が残っていると実装はConfigurationExceptionをスローします。

戻り値
IConfigurationロードされたIConfiguration 。デリゲート オブジェクトのOptionフィールドには、引数の値が入力されています。

投げる
ConfigurationException設定をロードできなかった場合

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

nullの 2 番目の引数をERROR(/#createConfigurationFromArgs(String[],List))を呼び出す便利なメソッド。したがって、未使用の引数が残っている場合は、 ConfigurationExceptionがスローされます。

パラメーター
args String

戻り値
IConfiguration

投げる
ConfigurationException

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

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                 unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

キー ストアを使用してコマンド ライン引数からIConfigurationを作成します。

予期される形式は「CONFIG [options]」です。ここで、CONFIG は、組み込みの構成名または構成 XML ファイルへのファイル パスです。

パラメーター
args String : コマンドライン引数

unconsumedArgs : 指定された構成に関連付けられたオブジェクトによって消費されなかった引数が設定されるリスト。これがnullの場合、未処理の引数が残っていると実装はConfigurationExceptionをスローします。

keyStoreClient IKeyStoreClient : 引数内の機密情報を取得するために使用されるIKeyStoreClient

戻り値
IConfigurationロードされたIConfiguration 。デリゲート オブジェクトのOptionフィールドには、引数の値が入力されています。

投げる
ConfigurationException設定をロードできなかった場合

createGlobalConfigurationFromArgs

public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, 
                 nonGlobalArgs)

コマンド ライン引数からIGlobalConfigurationを作成します。

予期される形式は「CONFIG [options]」です。ここで、CONFIG は、組み込みの構成名または構成 XML ファイルへのファイル パスです。

パラメーター
args String : コマンドライン引数

nonGlobalArgs : グローバル引数として処理されなかった引数が入力されるリスト

戻り値
IGlobalConfigurationロードされたIGlobalConfiguration 。デリゲート オブジェクトのOptionフィールドには、引数の値が入力されています。

投げる
ConfigurationException設定をロードできなかった場合

createPartialConfigurationFromArgs

public abstract IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                 allowedObjects, 
                TradefedDelegator delegator)

選択したオブジェクトのセットのみを含む構成を作成します。

パラメーター
arrayArgs String : コマンドライン引数

keyStoreClient IKeyStoreClient : 引数内の機密情報を取得するために使用されるIKeyStoreClient

allowedObjects : 作成が許可されたオブジェクトのセット

delegator TradefedDelegator

戻り値
IConfigurationロードされたIConfiguration

投げる
ConfigurationException設定をロードできなかった場合

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

設定の内容を指定されたERROR(/PrintStream)にダンプします。

パラメーター
configName String : 構成名

out PrintStream : 出力をダンプするERROR(/PrintStream)

getConfigList

public abstract  getConfigList ()

クラスパス上の JAR で見つかったすべての構成の名前のリストを返します。どの構成もロードしようとしないため、このリストには動作しない構成が含まれる可能性があります。

戻り値

getConfigList

public abstract  getConfigList (String subPath, 
                boolean loadFromEnv)

getConfigList()のバリエーションで、環境から構成をロードするかどうかを指定できます。

パラメーター
subPath String : 設定のために調べるサブディレクトリの名前。 null の場合、 getConfigList()と同じ動作になります。

loadFromEnv boolean : 環境変数に設定をロードする必要がある場合は True。

戻り値

プリントヘルプ

public abstract void printHelp (PrintStream out)

このファクトリのヘルプ出力を印刷します。

一般的なヘルプ情報を出力し、使用可能なすべての構成をリストします。

パラメーター
out PrintStream : 出力をダンプするERROR(/PrintStream)

printHelpForConfig

public abstract void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

コマンド ライン引数で指定されたIConfigurationのヘルプ出力を出力します。

「args」が既知の構成を参照している場合、XML からIConfigurationオブジェクトが作成され、そのIConfigurationのヘルプが出力されます。他のすべての 'args' 値は無視されることに注意してください (つまり、ヘルプ テキストでは XML からロードされたOptionの現在の値が説明され、コマンド ライン引数によって設定されたオプションの値は反映されません)。

'args' が既知のIConfigurationを参照していない場合は、汎用のprintHelp(PrintStream)ヘルプが表示されます。

パラメーター
args String : コマンドライン引数

importantOnly boolean : trueの場合、重要な詳細のみをリストした省略されたヘルプを出力します。

out PrintStream : 出力をダンプするERROR(/PrintStream)