構成ファクトリー

public class ConfigurationFactory
extends Object implements IConfigurationFactory

java.lang.オブジェクト
com.android.tradefed.config.ConfigurationFactory


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

まとめ

入れ子になったクラス

class ConfigurationFactory.ConfigLoader

1 つのルート構成からインクルードされた構成を追跡し、循環インクルードで例外をスローする IConfigDefLoader の実装。

class ConfigurationFactory.ExceptionLoader

保護されたコンストラクター

ConfigurationFactory ()

パブリックメソッド

void clearMapConfig ()

特定のケースでは、マップをクリアする必要があります。

IConfiguration createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs)

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

IConfiguration createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient)

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

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs)

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

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

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

void dumpConfig (String configName, PrintStream out)

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

getConfigList (String subPath, boolean loadFromEnv)

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

getConfigList ()

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

static IConfigurationFactory getInstance ()

シングルトンIConfigurationFactoryインスタンスを取得します。

void loadAllConfigs (boolean discardExceptions)

クラスパスおよびテスト ケース ディレクトリにあるすべての設定をロードします。

void loadAndPrintAllConfigs ()

すべての構成をロード、解析でき、すべてのオプション値を設定できることを確認するユーティリティ メソッド。

void printHelp (PrintStream out)

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

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

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

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

保護されたメソッド

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

クラスパス上の構成 XML ファイルのパス接頭辞を返します。

単体テストがモックできるように公開されています。

BufferedInputStream getConfigStream (String name)

指定された構成名のInputStreamをロードします。

ConfigurationDef getConfigurationDef (String name, boolean isGlobal, templateMap) getConfigurationDef (String name, boolean isGlobal, templateMap)

指定された名前のConfigurationDefを取得します

getMapConfig ()

テストのために露出しました。

boolean isDirectConfiguration (String configName)
String[] reorderArgs (String[] args)

template:map 引数がすべて前に移動されるように、引数を並べ替えます。

IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)

保護されたコンストラクター

構成ファクトリー

protected ConfigurationFactory ()

パブリックメソッド

クリアマップ構成

public void clearMapConfig ()

特定のケースでは、マップをクリアする必要があります。

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

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

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

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

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

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

投げる
ConfigurationException

createConfigurationFromArgs

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

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

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

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

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

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

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

投げる
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

パラメーター
arrayArgs String

戻り値
IConfiguration

投げる
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

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

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

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

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

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

投げる
ConfigurationException

createPartialConfigurationFromArgs

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

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

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

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

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

delegator TradefedDelegator

戻り値
IConfigurationロードされたIConfiguration

投げる
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

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

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

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

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

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

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

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

戻り値

getConfigList

public  getConfigList ()

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

戻り値

インスタンスの取得

public static IConfigurationFactory getInstance ()

シングルトンIConfigurationFactoryインスタンスを取得します。

戻り値
IConfigurationFactory

すべての構成をロードする

public void loadAllConfigs (boolean discardExceptions)

クラスパスおよびテスト ケース ディレクトリにあるすべての設定をロードします。

パラメーター
discardExceptions boolean : ConfigurationException を無視する必要がある場合は true。

投げる
com.android.tradefed.config.ConfigurationException
ConfigurationException

ロードアンドプリントオールコンフィグ

public void loadAndPrintAllConfigs ()

すべての構成をロード、解析でき、すべてのオプション値を設定できることを確認するユーティリティ メソッド。依存するプロジェクトが構成を検証できるようにするためにのみ公開されます。コンソールに公開すべきではありません。

投げる
ConfigurationException 1 つ以上の構成のロードに失敗した場合

プリントヘルプ

public void printHelp (PrintStream out)

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

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

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

printHelpForConfig

public 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)

保護されたメソッド

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

パラメーター
name String

戻り値
InputStream

getConfigPrefix

protected String getConfigPrefix ()

クラスパス上の構成 XML ファイルのパス接頭辞を返します。

単体テストがモックできるように公開されています。

戻り値
String末尾に / を含むStringパス

getConfigStream

protected BufferedInputStream getConfigStream (String name)

指定された構成名のInputStreamをロードします。

パラメーター
name String : ロードする構成名

戻り値
BufferedInputStream構成コンテンツの読み取りERROR(/BufferedInputStream)

投げる
ConfigurationException構成が見つからなかった場合

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                 templateMap)

指定された名前のConfigurationDefを取得します

パラメーター
name String : ロードする組み込み構成の名前、またはロードする構成ファイルへのファイル パス

isGlobal boolean

templateMap

戻り値
ConfigurationDef ConfigurationDef

投げる
ConfigurationException構成のロード中にエラーが発生した場合

getMapConfig

protected  getMapConfig ()

テストのために露出しました。地図のコピーを返却してください。

戻り値

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

パラメーター
configName String

戻り値
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

template:map 引数がすべて前に移動されるように、引数を並べ替えます。

パラメーター
args String

戻り値
String[]

解決リモートファイル

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

パラメーター
configURI URI

destDir URI

戻り値
IRemoteFileResolver.ResolvedFile

投げる
BuildRetrievalError