IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory

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

概要

パブリック メソッド

abstract IConfiguration createConfigurationFromArgs(String[] args, unconsumedArgs)

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

abstract IConfiguration createConfigurationFromArgs(String[] args)

2 番目の引数に null を指定して ERROR(/#createConfigurationFromArgs(String[],List)) を呼び出すコンビニエンス メソッド。

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

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

abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, nonGlobalArgs)

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

abstract IConfiguration 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」が既知の構成を参照している場合、IConfiguration オブジェクトが XML から作成され、その IConfiguration のヘルプが出力されます。

パブリック メソッド

createConfigurationFromArgs

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

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

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

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

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

2 番目の引数として null を指定して ERROR(/#createConfigurationFromArgs(String[],List)) を呼び出すコンビニエンス メソッド。したがって、消費されていない引数が残っている場合は ConfigurationException がスローされます。

パラメータ
args String

戻り値
IConfiguration

例外
ConfigurationException

createConfigurationFromArgs

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

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

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

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

createGlobalConfigurationFromArgs

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

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

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

パラメータ
args String: コマンドライン引数
nonGlobalArgs : グローバル引数として処理されなかった引数を格納するリスト
戻り値
IGlobalConfiguration 読み込まれた IGlobalConfiguration。デリゲート オブジェクトの Option フィールドに args の値が入力されています。
例外
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。
戻り値

printHelp

public abstract void printHelp (PrintStream out)

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

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

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

printHelpForConfig

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

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

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

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

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