配置
public class Configuration
extends Object
implements IConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.配置 |
一個具體的IConfiguration
實現,它將載入的配置物件儲存在映射中。
概括
領域 | |
---|---|
public static final String | BUILD_PROVIDER_TYPE_NAME |
public static final String | CMD_OPTIONS_TYPE_NAME |
public static final String | CONFIGURATION_DESCRIPTION_TYPE_NAME |
public static final String | COVERAGE_OPTIONS_TYPE_NAME |
public static final String | DEVICE_METRICS_COLLECTOR_TYPE_NAME |
public static final String | DEVICE_NAME |
public static final String | DEVICE_OPTIONS_TYPE_NAME |
public static final String | DEVICE_RECOVERY_TYPE_NAME |
public static final String | DEVICE_REQUIREMENTS_TYPE_NAME |
public static final String | GLOBAL_FILTERS_TYPE_NAME |
public static final String | LAB_PREPARER_TYPE_NAME |
public static final String | LOGGER_TYPE_NAME |
public static final String | LOG_SAVER_TYPE_NAME |
public static final String | METRIC_POST_PROCESSOR_TYPE_NAME |
public static final String | MULTI_PREPARER_TYPE_NAME |
public static final String | MULTI_PRE_TARGET_PREPARER_TYPE_NAME |
public static final String | RESULT_REPORTER_TYPE_NAME |
public static final String | RETRY_DECISION_TYPE_NAME |
public static final String | SANBOX_OPTIONS_TYPE_NAME |
public static final String | SANDBOX_TYPE_NAME |
public static final String | SKIP_MANAGER_TYPE_NAME |
public static final String | SYSTEM_STATUS_CHECKER_TYPE_NAME |
public static final String | TARGET_PREPARER_TYPE_NAME |
public static final String | TEST_TYPE_NAME
|
公共構造函數 | |
---|---|
Configuration (String name, String description) 使用預設配置物件建立 |
受保護的方法 | |
---|---|
boolean | isRemoteEnvironment () 傳回 TF 的環境是否為遠端呼叫。 |
領域
BUILD_PROVIDER_TYPE_NAME
public static final String BUILD_PROVIDER_TYPE_NAME
CMD_OPTIONS_TYPE_NAME
public static final String CMD_OPTIONS_TYPE_NAME
CONFIGURATION_DESCRIPTION_TYPE_NAME
public static final String CONFIGURATION_DESCRIPTION_TYPE_NAME
COVERAGE_OPTIONS_TYPE_NAME
public static final String COVERAGE_OPTIONS_TYPE_NAME
DEVICE_METRICS_COLLECTOR_TYPE_NAME
public static final String DEVICE_METRICS_COLLECTOR_TYPE_NAME
設備名稱
public static final String DEVICE_NAME
DEVICE_OPTIONS_TYPE_NAME
public static final String DEVICE_OPTIONS_TYPE_NAME
DEVICE_RECOVERY_TYPE_NAME
public static final String DEVICE_RECOVERY_TYPE_NAME
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
GLOBAL_FILTERS_TYPE_NAME
public static final String GLOBAL_FILTERS_TYPE_NAME
LAB_PREPARER_TYPE_NAME
public static final String LAB_PREPARER_TYPE_NAME
LOGGER_TYPE_NAME
public static final String LOGGER_TYPE_NAME
LOG_SAVER_TYPE_NAME
public static final String LOG_SAVER_TYPE_NAME
METRIC_POST_PROCESSOR_TYPE_NAME
public static final String METRIC_POST_PROCESSOR_TYPE_NAME
MULTI_PREPARER_TYPE_NAME
public static final String MULTI_PREPARER_TYPE_NAME
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
public static final String MULTI_PRE_TARGET_PREPARER_TYPE_NAME
RESULT_REPORTER_TYPE_NAME
public static final String RESULT_REPORTER_TYPE_NAME
RETRY_DECISION_TYPE_NAME
public static final String RETRY_DECISION_TYPE_NAME
SANBOX_OPTIONS_TYPE_NAME
public static final String SANBOX_OPTIONS_TYPE_NAME
SANDBOX_TYPE_NAME
public static final String SANDBOX_TYPE_NAME
SKIP_MANAGER_TYPE_NAME
public static final String SKIP_MANAGER_TYPE_NAME
SYSTEM_STATUS_CHECKER_TYPE_NAME
public static final String SYSTEM_STATUS_CHECKER_TYPE_NAME
TARGET_PREPARER_TYPE_NAME
public static final String TARGET_PREPARER_TYPE_NAME
測試類型名稱
public static final String TEST_TYPE_NAME
公共構造函數
配置
public Configuration (String name, String description)
使用預設配置物件建立Configuration
。
參數 | |
---|---|
name | String |
description | String |
公共方法
新增要清理的文件
public void addFilesToClean (toBeCleaned)
新增必須在cleanConfigurationData()
期間清理的文件
參數 | |
---|---|
toBeCleaned |
清理配置數據
public void cleanConfigurationData ()
刪除下載到遠端文件解析選項欄位的所有檔案。
轉儲Xml
public void dumpXml (PrintWriter output)
取得配置的擴充 XML 文件,其中以String
顯示此IConfiguration
的所有選項。
參數 | |
---|---|
output | PrintWriter :列印 xml 的編寫器。 |
轉儲Xml
public void dumpXml (PrintWriter output,excludeFilters)
取得配置的擴充 XML 文件,其中包含此IConfiguration
顯示的所有選項,減去按鍵名稱篩選的物件。
過濾器範例: Configuration#TARGET_PREPARER_TYPE_NAME
。
參數 | |
---|---|
output | PrintWriter :列印 xml 的編寫器。 |
excludeFilters |
轉儲Xml
public void dumpXml (PrintWriter output,excludeFilters, boolean printDeprecatedOptions, boolean printUnchangedOptions)
取得配置的擴充 XML 文件,其中包含此IConfiguration
顯示的所有選項,減去按鍵名稱篩選的物件。
過濾器範例: Configuration#TARGET_PREPARER_TYPE_NAME
。
參數 | |
---|---|
output | PrintWriter :列印 xml 的編寫器。 |
excludeFilters | |
printDeprecatedOptions | boolean : 是否會列印標記為已棄用的選項 |
printUnchangedOptions | boolean |
取得所有配置物件類型
publicgetAllConfigurationObjectsOfType (String configType)
用於跨裝置取得給定類型名稱的所有物件的通用介面。
參數 | |
---|---|
configType | String : 配置物件的唯一類型 |
退貨 | |
---|---|
給定類型的配置物件的清單。 |
取得建置提供者
public IBuildProvider getBuildProvider ()
從配置中取得IBuildProvider
。
退貨 | |
---|---|
IBuildProvider | 配置中提供的IBuildProvider |
取得命令選項
public ICommandOptions getCommandOptions ()
從配置中取得要使用的ICommandOptions
。
退貨 | |
---|---|
ICommandOptions | 配置中提供的ICommandOptions 。 |
取得配置描述
public ConfigurationDescriptor getConfigurationDescription ()
傳回配置中提供的ConfigurationDescriptor
。
退貨 | |
---|---|
ConfigurationDescriptor |
取得配置對象
public Object getConfigurationObject (String typeName)
用於取得具有給定類型名稱的配置物件的通用介面。
參數 | |
---|---|
typeName | String : 配置物件的唯一類型 |
退貨 | |
---|---|
Object | 配置對象,如果給定名稱的對象類型不存在,則null 。 |
取得配置對象列表
publicgetConfigurationObjectList (String typeName)
與getConfigurationObject(String)
類似,但適用於支援多個物件的配置物件類型。
參數 | |
---|---|
typeName | String : 配置物件的唯一類型名稱 |
退貨 | |
---|---|
配置物件列表,如果給定名稱的物件類型不存在,則null 。 |
取得覆蓋選項
public CoverageOptions getCoverageOptions ()
從配置中取得要使用的CoverageOptions
。
退貨 | |
---|---|
CoverageOptions | 配置中提供的CoverageOptions 。 |
取得設備配置按名稱
public IDeviceConfiguration getDeviceConfigByName (String nameDevice)
傳回與提供的名稱關聯的IDeviceConfiguration
,如果找不到則傳回 null。
參數 | |
---|---|
nameDevice | String |
退貨 | |
---|---|
IDeviceConfiguration |
取得設備選項
public TestDeviceOptions getDeviceOptions ()
從配置中取得要使用的TestDeviceOptions
。
退貨 | |
---|---|
TestDeviceOptions | 配置中提供的TestDeviceOptions 。 |
取得設備恢復
public IDeviceRecovery getDeviceRecovery ()
從設定中取得要使用的IDeviceRecovery
。
退貨 | |
---|---|
IDeviceRecovery | 配置中提供的IDeviceRecovery 。 |
取得設備需求
public IDeviceSelection getDeviceRequirements ()
從配置中取得要使用的IDeviceSelection
。
退貨 | |
---|---|
IDeviceSelection | 配置中提供的IDeviceSelection 。 |
取得InopOptions
publicgetInopOptions ()
取得未更改任何值的選項名稱
退貨 | |
---|---|
取得日誌輸出
public ILeveledLogOutput getLogOutput ()
從配置中取得要使用的ILeveledLogOutput
。
退貨 | |
---|---|
ILeveledLogOutput | 配置中提供的ILeveledLogOutput 。 |
getMultiPreTargetPreparers
publicgetMultiPreTargetPreparers ()
從配置中取得IMultiTargetPreparer
,該配置應在任何設備 target_preparers 之前執行。
退貨 | |
---|---|
在配置中依序提供的IMultiTargetPreparer |
取得多目標準備器
publicgetMultiTargetPreparers ()
從配置中取得IMultiTargetPreparer
。
退貨 | |
---|---|
在配置中依序提供的IMultiTargetPreparer |
取得名稱
public String getName ()
傳回配置的名稱。
退貨 | |
---|---|
String |
取得系統狀態檢查器
publicgetSystemStatusCheckers ()
從配置中取得ISystemStatusChecker
。
退貨 | |
---|---|
配置中依序提供的ISystemStatusChecker |
取得測試調用監聽器
publicgetTestInvocationListeners ()
從設定中取得要使用的ITestInvocationListener
。
退貨 | |
---|---|
配置中提供的ITestInvocationListener 。 |
注入選項值
public void injectOptionValue (String optionName, String optionValue)
將選項值注入到配置物件集中。
對於為動態產生的選項提供值很有用。參數 | |
---|---|
optionName | String : 選項名稱 |
optionValue | String : 選項值 |
投擲 | |
---|---|
ConfigurationException |
注入選項值
public void injectOptionValue (String optionName, String optionKey, String optionValue)
將選項值注入到配置物件集中。
對於為動態產生的選項提供值很有用。參數 | |
---|---|
optionName | String : 選項名稱 |
optionKey | String : 地圖選項的可選鍵,或 null |
optionValue | String : 地圖選項值 |
投擲 | |
---|---|
ConfigurationException |
注入選項值與來源
public void injectOptionValueWithSource (String optionName, String optionKey, String optionValue, String source)
將選項值注入到配置物件集中。
對於為動態產生的選項提供值很有用。參數 | |
---|---|
optionName | String : 選項名稱 |
optionKey | String : 地圖選項的可選鍵,或 null |
optionValue | String : 地圖選項值 |
source | String :提供此選項值的來源配置 |
投擲 | |
---|---|
ConfigurationException |
注入選項值
public void injectOptionValues (optionDefs)
將多個選項值注入到組態物件集中。
在建立新物件後一次注入多個選項值非常有用。參數 | |
---|---|
optionDefs |
投擲 | |
---|---|
ConfigurationException |
isDeviceConfiguredFake
public boolean isDeviceConfiguredFake (String deviceName)
傳回已配置設備是否標記為 isFake=true。
參數 | |
---|---|
deviceName | String |
退貨 | |
---|---|
boolean |
部分深克隆
public IConfiguration partialDeepClone (objectToDeepClone, IKeyStoreClient client)
從clone()
建立一個基本克隆,然後深度克隆給定配置物件的清單。
參數 | |
---|---|
objectToDeepClone | |
client | IKeyStoreClient :金鑰庫客戶端。 |
退貨 | |
---|---|
IConfiguration | 部分深度克隆的配置。 |
投擲 | |
---|---|
ConfigurationException |
列印命令用法
public void printCommandUsage (boolean importantOnly, PrintStream out)
將此配置的命令列使用幫助文字輸出到給定的 printStream。
參數 | |
---|---|
importantOnly | boolean :如果為true 則只列印重要選項的協助 |
out | PrintStream :要使用的ERROR(/PrintStream) 。 |
投擲 | |
---|---|
| com.android.tradefed.config.ConfigurationException |
ConfigurationException |
解析動態選項
public void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
解決指向遠端位置的ERROR(/File)
選項。這需要呼叫cleanConfigurationData()
來清理檔案。
參數 | |
---|---|
resolver | DynamicRemoteFileResolver :解析檔案的DynamicRemoteFileResolver |
投擲 | |
---|---|
BuildRetrievalError | |
ConfigurationException |
安全注入選項值
public void safeInjectOptionValues (optionDefs)
將多個選項值注入到一組配置物件中,如果其中一個選項無法套用,則不會拋出異常。
在建立新物件後一次注入多個選項值非常有用。
參數 | |
---|---|
optionDefs |
投擲 | |
---|---|
ConfigurationException |
setBestEffortOptionsFromCommandLineArgs
publicsetBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用盡力而為的方法使用給定的一組命令列參數設定配置Option
欄位。
請參閱ArgsOptionParser
以了解預期格式
參數 | |
---|---|
listArgs | |
keyStoreClient | IKeyStoreClient :要使用的IKeyStoreClient 。 |
退貨 | |
---|---|
未消耗的參數 |
投擲 | |
---|---|
ConfigurationException |
設定建置提供者
public void setBuildProvider (IBuildProvider provider)
替換配置中目前的IBuildProvider
。
參數 | |
---|---|
provider | IBuildProvider :新的IBuildProvider |
設定命令列
public void setCommandLine (String[] arrayArgs)
設定用於建立此IConfiguration
命令列。與 setOptionsFromCommandLineArgs 不同,它儲存整個命令行,包括配置名稱。
參數 | |
---|---|
arrayArgs | String :命令列 |
設定配置對象
public void setConfigurationObject (String typeName, Object configObject)
使用給定名稱設定配置物件的通用方法,替換任何現有值。
參數 | |
---|---|
typeName | String :配置物件類型的唯一名稱。 |
configObject | Object :配置對象 |
投擲 | |
---|---|
ConfigurationException |
設定配置對象列表
public void setConfigurationObjectList (String typeName,configList)
設定給定名稱的配置物件清單的通用方法,替換任何現有值。
參數 | |
---|---|
typeName | String :配置物件類型的唯一名稱。 |
configList |
投擲 | |
---|---|
ConfigurationException |
設定覆蓋選項
public void setCoverageOptions (CoverageOptions coverageOptions)
設定CoverageOptions
,替換任何現有值。
參數 | |
---|---|
coverageOptions | CoverageOptions |
設定設備配置
public void setDeviceConfig (IDeviceConfiguration deviceConfig)
設定IDeviceConfiguration
,取代任何現有值。
設定設備指標收集器
public void setDeviceMetricCollectors (collectors)
設定IMetricCollector
列表,取代任何現有值。
參數 | |
---|---|
collectors |
設定設備選項
public void setDeviceOptions (TestDeviceOptions devOptions)
設定TestDeviceOptions
,替換任何現有值
參數 | |
---|---|
devOptions | TestDeviceOptions |
設定設備要求
public void setDeviceRequirements (IDeviceSelection devRequirements)
設定IDeviceSelection
,替換任何現有值
setMultiPreTargetPreparer
public void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPrep)
在此組態中設定單一IMultiTargetPreparer
便利方法,該方法應在任何裝置 target_preparers 之前執行,取代任何現有值
setMultiPreTargetPreparers
public void setMultiPreTargetPreparers (multiPreTargPreps)
設定此配置中的IMultiTargetPreparer
列表,該列表應在任何裝置 target_preparers 之前執行,取代任何現有值
設定多目標準備器
public void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)
在此配置中設定單一IMultiTargetPreparer
便捷方法,取代任何現有值
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
使用給定的一組命令列參數設定配置Option
字段
ArgsOptionParser
用於預期格式參數 | |
---|---|
listArgs |
退貨 | |
---|---|
未消耗的參數 |
投擲 | |
---|---|
ConfigurationException |
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用給定的一組命令列參數設定配置Option
字段
ArgsOptionParser
以了解預期格式參數 | |
---|---|
listArgs | |
keyStoreClient | IKeyStoreClient :要使用的IKeyStoreClient 。 |
退貨 | |
---|---|
未消耗的參數 |
投擲 | |
---|---|
ConfigurationException |
設定係統狀態檢查器
public void setSystemStatusChecker (ISystemStatusChecker systemChecker)
在此配置中設定單一ISystemStatusChecker
便捷方法,取代任何現有值
設定係統狀態檢查器
public void setSystemStatusCheckers (systemCheckers)
在此配置中設定ISystemStatusChecker
列表,取代任何現有值
設定測試調用監聽器
public void setTestInvocationListener (ITestInvocationListener listener)
設定單一ITestInvocationListener
便捷方法
受保護的方法
是遠端環境
protected boolean isRemoteEnvironment ()
傳回 TF 的環境是否為遠端呼叫。
退貨 | |
---|---|
boolean |