IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory

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

概要

パブリック メソッド

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

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

abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs)

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

abstract IConfiguration createConfigurationFromArgs(String[] args)

createConfigurationFromArgs(String[],List) を null の 2 番目の引数で呼び出す便利なメソッド。
abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, List<String> nonGlobalArgs)

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

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

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

abstract void dumpConfig(String configName, PrintStream out)

構成の内容を指定された PrintStream にダンプします。
abstract List<String> getConfigList()

クラスパス上の JAR にあるすべての構成の名前のリストを返します。

abstract List<String> 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, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

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

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

パラメータ
args String: コマンドライン引数
unconsumedArgs List: 指定された構成に関連付けられたオブジェクトによって使用されなかった引数が格納されるリスト。これが nullの場合、未処理の引数が残っていると、実装は ConfigurationExceptionをスローします。
keyStoreClient IKeyStoreClient: 引数内の機密情報を取得するために使用される IKeyStoreClient。
戻り値
IConfiguration 読み込まれた IConfiguration。デリゲート オブジェクトの Option フィールドには、引数の値が設定されています。
例外
ConfigurationException 構成を読み込めなかった場合

createConfigurationFromArgs

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

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

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

パラメータ
args String: コマンドライン引数
unconsumedArgs List: 指定された構成に関連付けられたオブジェクトによって使用されなかった引数が格納されるリスト。これが nullの場合、未処理の引数が残っていると、実装は ConfigurationExceptionをスローします。
戻り値
IConfiguration 読み込まれた IConfiguration。デリゲート オブジェクトの Option フィールドには、引数の値が設定されています。
例外
ConfigurationException 構成を読み込めなかった場合

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

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

パラメータ
args String

戻り値
IConfiguration

例外
ConfigurationException

createGlobalConfigurationFromArgs

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

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

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

パラメータ
args String: コマンドライン引数
nonGlobalArgs List: グローバル引数として処理されなかった引数が格納されるリスト
戻り値
IGlobalConfiguration 読み込まれた IGlobalConfiguration。デリゲート オブジェクトの Option フィールド には、引数の値が設定されています。
例外
ConfigurationException 構成を読み込めなかった場合

createPartialConfigurationFromArgs

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

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

パラメータ
arrayArgs String: コマンドライン引数
keyStoreClient IKeyStoreClient: 引数内の機密情報を取得するために使用される IKeyStoreClient。
allowedObjects Set: 作成が許可されているオブジェクトのセット
delegator TradefedDelegator

戻り値
IConfiguration 読み込まれた IConfiguration。
例外
ConfigurationException 構成を読み込めなかった場合

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

構成の内容を指定された PrintStream にダンプします。

パラメータ
configName String: 構成名
out PrintStream: 出力をダンプする PrintStream

getConfigList

public abstract List<String> getConfigList ()

クラスパス上の JAR にあるすべての構成の名前のリストを返します。 構成の読み込みは試行されないため、このリストに機能しない構成 が含まれている可能性があります。

戻り値
List<String>

getConfigList

public abstract List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

getConfigList() のバリエーション。環境から構成を読み込むかどうかを指定できます。

パラメータ
subPath String: 構成を検索するサブディレクトリの名前。null の場合、 同じ動作になりますgetConfigList()。
loadFromEnv boolean: 環境変数に構成を読み込む場合は true。
戻り値
List<String>

printHelp

public abstract void printHelp (PrintStream out)

この Factory のヘルプ出力を出力します。

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

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

printHelpForConfig

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

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

'args' が既知の構成を参照している場合、IConfiguration オブジェクトが XML から作成され、その IConfiguration のヘルプが出力されます。他のすべての 'args' 値は無視されます（つまり、ヘルプテキストには XML から読み込まれた Options の現在の値が記述され、コマンドライン引数で設定されたオプションの値は反映されません）。

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

パラメータ
args String: コマンドライン引数
importantOnly boolean：true の場合、 重要な詳細のみを記載した簡略版のヘルプを出力します。
out PrintStream: 出力をダンプする PrintStream