配置
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 | 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
沙盒_TYPE_NAME
public static final String SANDBOX_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
TEST_TYPE_NAME
public static final String TEST_TYPE_NAME
公共構造函數
配置
public Configuration (String name, String description)
使用默認配置對象創建Configuration
。
參數 | |
---|---|
name | String |
description | String |
公共方法
清理配置數據
public void cleanConfigurationData ()
刪除已下載到遠程文件的已解析選項字段的所有文件。
轉儲XML
public void dumpXml (PrintWriter output)
獲取配置的擴展 XML 文件,其中所有選項為此IConfiguration
顯示為ERROR(/String)
。
參數 | |
---|---|
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 |
getAllConfigurationObjectsOfType
publicgetAllConfigurationObjectsOfType (String configType)
跨設備獲取一個給定類型名稱的所有對象的通用接口。
參數 | |
---|---|
configType | String : 配置對象的唯一類型 |
退貨 | |
---|---|
給定類型的配置對象列表。 |
getBuildProvider
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 。 |
getDeviceConfigByName
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 。 |
getInop選項
publicgetInopOptions ()
獲取未更改任何值的選項名稱
退貨 | |
---|---|
獲取日誌輸出
public ILeveledLogOutput getLogOutput ()
從配置中獲取要使用的ILeveledLogOutput
。
退貨 | |
---|---|
ILeveledLogOutput | 配置中提供的ILeveledLogOutput 。 |
getMultiPreTargetPreparers
publicgetMultiPreTargetPreparers ()
從應在任何設備 target_preparers 之前執行的配置中獲取IMultiTargetPreparer
s。
退貨 | |
---|---|
在配置中按順序提供的IMultiTargetPreparer |
getMultiTargetPreparers
publicgetMultiTargetPreparers ()
從配置中獲取IMultiTargetPreparer
。
退貨 | |
---|---|
在配置中按順序提供的IMultiTargetPreparer |
獲取名稱
public String getName ()
返回配置的名稱。
退貨 | |
---|---|
String |
getSystemStatusCheckers
publicgetSystemStatusCheckers ()
從配置中獲取ISystemStatusChecker
。
退貨 | |
---|---|
在配置中按順序提供的ISystemStatusChecker |
getTestInvocationListeners
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 |
injectOptionValueWithSource
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
,替換任何現有值。
setDeviceMetricCollectors
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
便捷方法,替換任何現有值
setMultiTargetPreparers
public void setMultiTargetPreparers (multiTargPreps)
在此配置中設置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
的列表,替換任何現有值
setTestInvocationListener
public void setTestInvocationListener (ITestInvocationListener listener)
設置單個ITestInvocationListener
便捷方法
setTestInvocationListeners
public void setTestInvocationListeners (listeners)
設置ITestInvocationListener
的列表,替換任何現有值
受保護的方法
是遠程環境
protected boolean isRemoteEnvironment ()
返回 TF 的環境是否為遠程調用。
退貨 | |
---|---|
boolean |