配置工廠

public class ConfigurationFactory
extends Object implements IConfigurationFactory

java.lang.Object
↳	com.android.tradefed.config.ConfigurationFactory

已知的直接子類 GCSConfigurationFactory , RetryConfigurationFactory , SandboxConfigurationFactory GCSConfigurationFactory ConfigurationFactory從 Google Cloud Storage 加載配置。 重試配置工廠 處理重試命令的工廠。 沙盒配置工廠 特殊配置工廠，用於處理為沙盒目的創建配置。

---

用於創建IConfiguration的工廠。

概括

嵌套類
class	ConfigurationFactory.ConfigLoader 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第二個參數的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) 重新排序 args 以便 template:map args 全部移到前面。
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字段已填充 args 中的值。

投擲
ConfigurationException

createConfigurationFromArgs

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

使用密鑰庫從命令行參數創建IConfiguration 。

預期格式為“CONFIG [options]”，其中 CONFIG 是內置配置名稱或配置 xml 文件的文件路徑。

參數
arrayArgs	String : 命令行參數
unconsumedArgs	：一個列表，它將填充與指定配置關聯的對象未使用的參數。如果這是null ，那麼如果任何未處理的參數仍然存在，則實現將拋出ConfigurationException 。
keyStoreClient	IKeyStoreClient ：一個IKeyStoreClient用於獲取 args 中的敏感信息。

退貨
IConfiguration	加載的IConfiguration 。委託對象Option字段已填充 args 中的值。

投擲
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

一種方便的方法，它調用帶有null第二個參數的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字段已填充 args 中的值。

投擲
ConfigurationException

createPartialConfigurationFromArgs

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

創建僅包含一組選定對象的配置。

參數
arrayArgs	String : 命令行參數
keyStoreClient	IKeyStoreClient ：一個IKeyStoreClient用於獲取 args 中的敏感信息。
allowedObjects	: 允許創建的對象集
delegator	TradefedDelegator

退貨
IConfiguration	加載的IConfiguration 。

投擲
ConfigurationException

轉儲配置

public void dumpConfig (String configName, 
                PrintStream out)

將配置的內容轉儲到給定的ERROR(/PrintStream)

參數
configName	String : 配置名稱
out	PrintStream : 將輸出轉儲到的ERROR(/PrintStream)

獲取配置列表

public  getConfigList (String subPath, 
                boolean loadFromEnv)

getConfigList()的變體可以指定我們是否也想從環境中加載配置。

參數
subPath	String : 要查找配置的子目錄的名稱。如果為 null，則具有與getConfigList()相同的行為。
loadFromEnv	boolean ：如果我們應該在環境變量中加載配置，則為真。

退貨

獲取配置列表

public  getConfigList ()

返回在類路徑的 JAR 中找到的所有配置的名稱列表。不嘗試加載任何配置，因此此列表中可能有非工作配置。

退貨

獲取實例

public static IConfigurationFactory getInstance ()

獲取單例IConfigurationFactory實例。

退貨
IConfigurationFactory

加載所有配置

public void loadAllConfigs (boolean discardExceptions)

加載在類路徑和測試用例目錄中找到的所有配置。

參數
discardExceptions	boolean : 如果任何 ConfigurationException 應該被忽略，則為 true。

投擲
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

檢查所有配置是否可以加載、解析和所有選項值設置的實用方法。僅公開以便依賴項目可以驗證他們的配置。不應暴露在控制台中。

投擲
ConfigurationException	如果一個或多個配置加載失敗

打印幫助

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 設置的選項值。

如果 'args' 沒有引用已知的IConfiguration ，則將顯示通用printHelp(PrintStream)幫助。

參數
args	String : 命令行參數
importantOnly	boolean : 如果為true ，則打印一個僅列出重要細節的簡短幫助
out	PrintStream : 將輸出轉儲到的ERROR(/PrintStream)

受保護的方法

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

參數
name	String

退貨
InputStream

獲取配置前綴

protected String getConfigPrefix ()

返回類路徑上配置 xml 文件的路徑前綴

暴露所以單元測試可以模擬。

退貨
String	帶有尾隨 / 的String路徑

獲取配置流

protected BufferedInputStream getConfigStream (String name)

為給定的配置名稱加載 InputStream

參數
name	String : 要加載的配置名稱

退貨
BufferedInputStream	用於讀取配置內容的ERROR(/BufferedInputStream)

投擲
ConfigurationException	如果找不到配置

獲取配置定義

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

檢索給定名稱的ConfigurationDef

參數
name	String : 要加載的內置配置的名稱或要加載的配置文件的文件路徑
isGlobal	boolean
templateMap

退貨
ConfigurationDef	ConfigurationDef

投擲
ConfigurationException	如果加載配置時發生錯誤

獲取地圖配置

protected  getMapConfig ()

暴露用於測試。返回地圖的副本。

退貨

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

參數
configName	String

退貨
boolean

重新排序參數

protected String[] reorderArgs (String[] args)

重新排序 args 以便 template:map args 全部移到前面。

參數
args	String

退貨
String[]

解決遠程文件

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

參數
configURI	URI
destDir	URI

退貨
IRemoteFileResolver.ResolvedFile

投擲
BuildRetrievalError