I配置
public interface IConfiguration
com.android.tradefed.config.IConfiguration |
TradeFederation 調用的配置信息。每個 TradeFederation 調用都有一個IConfiguration
。 IConfiguration
存儲調用期間應使用的所有委託對象及其關聯的Option
的
概括
公共方法 | |
---|---|
abstract void | addFilesToClean ( toBeCleaned) addFilesToClean ( toBeCleaned) 添加必須在 |
abstract void | cleanConfigurationData () 刪除已下載到遠程文件的已解析選項字段的所有文件。 |
abstract IConfiguration | clone () 創建此對象的淺表副本。 |
abstract void | dumpXml (PrintWriter output) 獲取配置的擴展 XML 文件,其中所有選項為此 |
abstract void | dumpXml (PrintWriter output, excludeFilters) dumpXml (PrintWriter output, excludeFilters) 獲取配置的擴展 XML 文件,其中包含為此 |
abstract void | dumpXml (PrintWriter output, excludeFilters, boolean printDeprecatedOptions, boolean printUnchangedOptions) dumpXml (PrintWriter output, excludeFilters, boolean printDeprecatedOptions, boolean printUnchangedOptions) 獲取配置的擴展 XML 文件,其中包含為此 |
abstract | getAllConfigurationObjectsOfType (String typeName) 跨設備獲取一個給定類型名稱的所有對象的通用接口。 |
abstract IBuildProvider | getBuildProvider () 從配置中獲取 |
abstract String | getCommandLine () 獲取用於創建此 |
abstract ICommandOptions | getCommandOptions () 從配置中獲取要使用的 |
abstract ConfigurationDescriptor | getConfigurationDescription () 返回配置中提供的 |
abstract Object | getConfigurationObject (String typeName) 獲取具有給定類型名稱的配置對象的通用接口。 |
abstract | getConfigurationObjectList (String typeName) 類似於 |
abstract CoverageOptions | getCoverageOptions () 從配置中獲取要使用的 |
abstract | getDeviceConfig () 從配置中獲取 |
abstract IDeviceConfiguration | getDeviceConfigByName (String nameDevice) 返回與提供的名稱關聯的 |
abstract TestDeviceOptions | getDeviceOptions () 從配置中獲取要使用的 |
abstract IDeviceRecovery | getDeviceRecovery () 從配置中獲取要使用的 |
abstract IDeviceSelection | getDeviceRequirements () 從配置中獲取要使用的 |
abstract | getFilesToClean () 獲取將在 |
abstract GlobalTestFilter | getGlobalFilters () 獲取調用的 |
abstract | getInopOptions () 獲取未更改任何值的選項名稱 |
abstract | getLabPreparers () 從配置中獲取 |
abstract ILeveledLogOutput | getLogOutput () 從配置中獲取要使用的 |
abstract ILogSaver | getLogSaver () 從配置中獲取要使用的 |
abstract | getMetricCollectors () 從配置中獲取 |
abstract | getMultiPreTargetPreparers () 從應在任何設備 target_preparers 之前執行的配置中獲取 |
abstract | getMultiTargetPreparers () 從配置中獲取 |
abstract String | getName () 返回配置的名稱。 |
abstract | getPostProcessors () 從配置中獲取 |
abstract IRetryDecision | getRetryDecision () 返回用於調用的 |
abstract | getSystemStatusCheckers () 從配置中獲取 |
abstract | getTargetPreparers () 從配置中獲取 |
abstract | getTestInvocationListeners () 從配置中獲取要使用的 |
abstract | getTests () 獲取要從配置運行的 |
abstract void | injectOptionValue (String optionName, String optionValue) 將選項值注入到配置對象集中。 |
abstract void | injectOptionValue (String optionName, String optionKey, String optionValue) 將選項值注入到配置對象集中。 |
abstract void | injectOptionValueWithSource (String optionName, String optionKey, String optionValue, String optionSource) 將選項值注入到配置對象集中。 |
abstract void | injectOptionValues ( optionDefs) injectOptionValues ( optionDefs) 將多個選項值注入到配置對象集中。 |
abstract boolean | isDeviceConfiguredFake (String deviceName) 返回配置的設備是否標記為 isFake=true 或不。 |
abstract IConfiguration | partialDeepClone ( objectToDeepClone, IKeyStoreClient client) partialDeepClone ( objectToDeepClone, IKeyStoreClient client) 從 |
abstract void | printCommandUsage (boolean importantOnly, PrintStream out) 將此配置的命令行用法幫助文本輸出到給定的 printStream。 |
abstract void | resolveDynamicOptions ( DynamicRemoteFileResolver resolver) 解決指向遠程位置的 |
abstract void | safeInjectOptionValues ( optionDefs) safeInjectOptionValues ( optionDefs) 如果無法應用其中一個選項,則將多個選項值注入到配置對象集中而不拋出。 |
abstract | setBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient) setBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient) 使用盡力而為的方法使用給定的一組命令行參數設置配置 |
abstract void | setBuildProvider ( IBuildProvider provider) 替換配置中的當前 |
abstract void | setCommandLine (String[] arrayArgs) 設置用於創建此 |
abstract void | setCommandOptions ( ICommandOptions cmdOptions) 設置 |
abstract void | setConfigurationObject (String name, Object configObject) 使用給定名稱設置配置對象的通用方法,替換任何現有值。 |
abstract void | setConfigurationObjectList (String name, configList) setConfigurationObjectList (String name, configList) 為給定名稱設置配置對象列表的通用方法,替換任何現有值。 |
abstract void | setCoverageOptions ( CoverageOptions coverageOptions) 設置 |
abstract void | setDeviceConfig ( IDeviceConfiguration deviceConfig) 設置 |
abstract void | setDeviceConfigList ( deviceConfigs) setDeviceConfigList ( deviceConfigs) 設置 |
abstract void | setDeviceMetricCollectors ( collectors) setDeviceMetricCollectors ( collectors) 設置 |
abstract void | setDeviceOptions ( TestDeviceOptions deviceOptions) 設置 |
abstract void | setDeviceRecovery ( IDeviceRecovery recovery) 設置 |
abstract void | setDeviceRequirements ( IDeviceSelection deviceSelection) 設置 |
abstract void | setLabPreparer ( ITargetPreparer preparer) 設置 |
abstract void | setLabPreparers ( preparers) setLabPreparers ( preparers) 設置 |
abstract void | setLogOutput ( ILeveledLogOutput logger) 設置 |
abstract void | setLogSaver ( ILogSaver logSaver) 設置 |
abstract void | setMultiPreTargetPreparer ( IMultiTargetPreparer multiPreTargPreps) 在此配置中設置單個 |
abstract void | setMultiPreTargetPreparers ( multiPreTargPreps) setMultiPreTargetPreparers ( multiPreTargPreps) 在此配置中設置 |
abstract void | setMultiTargetPreparer ( IMultiTargetPreparer multiTargPrep) 在此配置中設置單個 |
abstract void | setMultiTargetPreparers ( multiTargPreps) setMultiTargetPreparers ( multiTargPreps) 在此配置中設置 |
abstract | setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs) 使用給定的命令行參數集設置配置 ArgsOptionParser |
abstract | setOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient) setOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient) 使用給定的命令行參數集設置配置 ArgsOptionParser |
abstract void | setPostProcessors ( processors) setPostProcessors ( processors) 設置 |
abstract void | setRetryDecision ( IRetryDecision decisionRetry) 設置 |
abstract void | setSystemStatusChecker ( ISystemStatusChecker systemChecker) 在此配置中設置單個 |
abstract void | setSystemStatusCheckers ( systemCheckers) setSystemStatusCheckers ( systemCheckers) 在此配置中設置 |
abstract void | setTargetPreparer ( ITargetPreparer preparer) 設置 |
abstract void | setTargetPreparers ( preparers) setTargetPreparers ( preparers) 設置 |
abstract void | setTest ( IRemoteTest test) 在此配置中設置單個 |
abstract void | setTestInvocationListener ( ITestInvocationListener listener) 設置單個 |
abstract void | setTestInvocationListeners ( listeners) setTestInvocationListeners ( listeners) 設置 |
abstract void | setTests ( tests) setTests ( tests) 在此配置中設置 |
abstract void | validateOptions () 驗證選項值。 |
公共方法
添加文件清理
public abstract void addFilesToClean (toBeCleaned)
添加必須在cleanConfigurationData()
期間清理的文件
參數 | |
---|---|
toBeCleaned |
清理配置數據
public abstract void cleanConfigurationData ()
刪除已下載到遠程文件的已解析選項字段的所有文件。
轉儲XML
public abstract void dumpXml (PrintWriter output)
獲取配置的擴展 XML 文件,其中所有選項為此IConfiguration
顯示為ERROR(/String)
。
參數 | |
---|---|
output | PrintWriter :將 xml 打印到的編寫器。 |
投擲 | |
---|---|
| 異常 |
轉儲XML
public abstract void dumpXml (PrintWriter output,excludeFilters)
獲取配置的擴展 XML 文件,其中包含為此IConfiguration
顯示的所有選項減去按鍵名篩選的對象。
過濾器示例: Configuration#TARGET_PREPARER_TYPE_NAME
。
參數 | |
---|---|
output | PrintWriter :將 xml 打印到的編寫器。 |
excludeFilters |
投擲 | |
---|---|
| 異常 |
轉儲XML
public abstract 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
public abstractgetAllConfigurationObjectsOfType (String typeName)
跨設備獲取一個給定類型名稱的所有對象的通用接口。
參數 | |
---|---|
typeName | String : 配置對象的唯一類型 |
退貨 | |
---|---|
給定類型的配置對象列表。 |
getBuildProvider
public abstract IBuildProvider getBuildProvider ()
從配置中獲取IBuildProvider
。
退貨 | |
---|---|
IBuildProvider | 配置中提供的IBuildProvider |
獲取命令行
public abstract String getCommandLine ()
獲取用於創建此IConfiguration
命令行。
退貨 | |
---|---|
String | 用於創建此IConfiguration 命令行。 |
獲取命令選項
public abstract ICommandOptions getCommandOptions ()
從配置中獲取要使用的ICommandOptions
。
退貨 | |
---|---|
ICommandOptions | 配置中提供的ICommandOptions 。 |
獲取配置說明
public abstract ConfigurationDescriptor getConfigurationDescription ()
返回配置中提供的ConfigurationDescriptor
。
退貨 | |
---|---|
ConfigurationDescriptor |
獲取配置對象
public abstract Object getConfigurationObject (String typeName)
獲取具有給定類型名稱的配置對象的通用接口。
參數 | |
---|---|
typeName | String : 配置對象的唯一類型 |
退貨 | |
---|---|
Object | 配置對象;如果具有給定名稱的對像類型不存在,則null 。 |
獲取配置對象列表
public abstractgetConfigurationObjectList (String typeName)
類似於getConfigurationObject(String)
,但適用於支持多個對象的配置對像類型。
參數 | |
---|---|
typeName | String : 配置對象的唯一類型名稱 |
退貨 | |
---|---|
配置對象列表,如果具有給定名稱的對像類型不存在,則返回null 。 |
獲取覆蓋選項
public abstract CoverageOptions getCoverageOptions ()
從配置中獲取要使用的CoverageOptions
。
退貨 | |
---|---|
CoverageOptions | 配置中提供的CoverageOptions 。 |
獲取設備配置
public abstractgetDeviceConfig ()
從配置中獲取IDeviceConfiguration
。
退貨 | |
---|---|
配置中按順序提供的IDeviceConfiguration |
getDeviceConfigByName
public abstract IDeviceConfiguration getDeviceConfigByName (String nameDevice)
返回與提供的名稱關聯的IDeviceConfiguration
,如果未找到則返回 null。
參數 | |
---|---|
nameDevice | String |
退貨 | |
---|---|
IDeviceConfiguration |
獲取設備選項
public abstract TestDeviceOptions getDeviceOptions ()
從配置中獲取要使用的TestDeviceOptions
。
退貨 | |
---|---|
TestDeviceOptions | 配置中提供的TestDeviceOptions 。 |
獲取設備恢復
public abstract IDeviceRecovery getDeviceRecovery ()
從配置中獲取要使用的IDeviceRecovery
。
退貨 | |
---|---|
IDeviceRecovery | 配置中提供的IDeviceRecovery 。 |
獲取設備要求
public abstract IDeviceSelection getDeviceRequirements ()
從配置中獲取要使用的IDeviceSelection
。
退貨 | |
---|---|
IDeviceSelection | 配置中提供的IDeviceSelection 。 |
獲取全局過濾器
public abstract GlobalTestFilter getGlobalFilters ()
獲取調用的GlobalTestFilter
。
退貨 | |
---|---|
GlobalTestFilter |
getInop選項
public abstractgetInopOptions ()
獲取未更改任何值的選項名稱
退貨 | |
---|---|
getLabPreparers
public abstractgetLabPreparers ()
從配置中獲取ITargetPreparer
。
退貨 | |
---|---|
在配置中按順序提供的ITargetPreparer |
獲取日誌輸出
public abstract ILeveledLogOutput getLogOutput ()
從配置中獲取要使用的ILeveledLogOutput
。
退貨 | |
---|---|
ILeveledLogOutput | 配置中提供的ILeveledLogOutput 。 |
獲取LogSaver
public abstract ILogSaver getLogSaver ()
從配置中獲取要使用的ILogSaver
。
退貨 | |
---|---|
ILogSaver | 配置中提供的ILogSaver 。 |
getMultiPreTargetPreparers
public abstractgetMultiPreTargetPreparers ()
從應在任何設備 target_preparers 之前執行的配置中獲取IMultiTargetPreparer
s。
退貨 | |
---|---|
在配置中按順序提供的IMultiTargetPreparer |
getMultiTargetPreparers
public abstractgetMultiTargetPreparers ()
從配置中獲取IMultiTargetPreparer
。
退貨 | |
---|---|
在配置中按順序提供的IMultiTargetPreparer |
獲取名稱
public abstract String getName ()
返回配置的名稱。
退貨 | |
---|---|
String |
getSystemStatusCheckers
public abstractgetSystemStatusCheckers ()
從配置中獲取ISystemStatusChecker
。
退貨 | |
---|---|
在配置中按順序提供的ISystemStatusChecker |
getTargetPreparers
public abstractgetTargetPreparers ()
從配置中獲取ITargetPreparer
。
退貨 | |
---|---|
在配置中按順序提供的ITargetPreparer |
getTestInvocationListeners
public abstractgetTestInvocationListeners ()
從配置中獲取要使用的ITestInvocationListener
。
退貨 | |
---|---|
配置中提供的ITestInvocationListener 。 |
注入選項值
public abstract void injectOptionValue (String optionName, String optionValue)
將選項值注入到配置對象集中。
為動態生成的選項提供值很有用。參數 | |
---|---|
optionName | String :選項名稱 |
optionValue | String : 選項值 |
投擲 | |
---|---|
ConfigurationException | 如果未能設置選項的值 |
注入選項值
public abstract void injectOptionValue (String optionName, String optionKey, String optionValue)
將選項值注入到配置對象集中。
為動態生成的選項提供值很有用。參數 | |
---|---|
optionName | String :選項名稱 |
optionKey | String : 地圖選項的可選鍵,或 null |
optionValue | String : 地圖選項值 |
投擲 | |
---|---|
ConfigurationException | 如果未能設置選項的值 |
injectOptionValueWithSource
public abstract void injectOptionValueWithSource (String optionName, String optionKey, String optionValue, String optionSource)
將選項值注入到配置對象集中。
為動態生成的選項提供值很有用。參數 | |
---|---|
optionName | String :選項名稱 |
optionKey | String : 地圖選項的可選鍵,或 null |
optionValue | String : 地圖選項值 |
optionSource | String :提供此選項值的源配置 |
投擲 | |
---|---|
ConfigurationException | 如果未能設置選項的值 |
注入選項值
public abstract void injectOptionValues (optionDefs)
將多個選項值注入到配置對象集中。
在創建新對像後一次注入許多選項值很有用。參數 | |
---|---|
optionDefs |
投擲 | |
---|---|
ConfigurationException | 如果未能設置選項值 |
isDeviceConfiguredFake
public abstract boolean isDeviceConfiguredFake (String deviceName)
返回配置的設備是否標記為 isFake=true 或不。
參數 | |
---|---|
deviceName | String |
退貨 | |
---|---|
boolean |
部分深度克隆
public abstract IConfiguration partialDeepClone (objectToDeepClone, IKeyStoreClient client)
從clone()
創建一個基礎克隆,然後深度克隆給定配置對象的列表。
參數 | |
---|---|
objectToDeepClone | |
client | IKeyStoreClient :密鑰庫客戶端。 |
退貨 | |
---|---|
IConfiguration | 部分深度克隆的配置。 |
投擲 | |
---|---|
| com.android.tradefed.config.ConfigurationException |
ConfigurationException |
打印命令用法
public abstract void printCommandUsage (boolean importantOnly, PrintStream out)
將此配置的命令行用法幫助文本輸出到給定的 printStream。
參數 | |
---|---|
importantOnly | boolean :如果為true 則只打印重要選項的幫助 |
out | PrintStream :要使用的ERROR(/PrintStream) 。 |
投擲 | |
---|---|
| com.android.tradefed.config.ConfigurationException |
ConfigurationException |
解析動態選項
public abstract void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
解決指向遠程位置的ERROR(/File)
選項。這需要調用cleanConfigurationData()
來清理文件。
參數 | |
---|---|
resolver | DynamicRemoteFileResolver :用於解析文件的DynamicRemoteFileResolver |
投擲 | |
---|---|
| com.android.tradefed.build.BuildRetrievalError |
| com.android.tradefed.config.ConfigurationException |
BuildRetrievalError | |
ConfigurationException |
安全注入選項值
public abstract void safeInjectOptionValues (optionDefs)
如果無法應用其中一個選項,則將多個選項值注入到配置對象集中而不拋出。
在創建新對像後一次注入許多選項值很有用。
參數 | |
---|---|
optionDefs |
投擲 | |
---|---|
ConfigurationException | 如果創建OptionSetter 失敗 |
setBestEffortOptionsFromCommandLineArgs
public abstractsetBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用盡力而為的方法使用給定的一組命令行參數設置配置Option
字段。
有關預期格式,請參閱ArgsOptionParser
參數 | |
---|---|
listArgs | |
keyStoreClient | IKeyStoreClient :要使用的IKeyStoreClient 。 |
退貨 | |
---|---|
未使用的參數 |
投擲 | |
---|---|
ConfigurationException |
設置構建提供者
public abstract void setBuildProvider (IBuildProvider provider)
替換配置中的當前IBuildProvider
。
參數 | |
---|---|
provider | IBuildProvider :新的IBuildProvider |
設置命令行
public abstract void setCommandLine (String[] arrayArgs)
設置用於創建此IConfiguration
命令行。這存儲了整個命令行,包括配置名稱,與 setOptionsFromCommandLineArgs 不同。
參數 | |
---|---|
arrayArgs | String :命令行 |
設置命令選項
public abstract void setCommandOptions (ICommandOptions cmdOptions)
設置ICommandOptions
,替換任何現有值
設置配置對象
public abstract void setConfigurationObject (String name, Object configObject)
使用給定名稱設置配置對象的通用方法,替換任何現有值。
參數 | |
---|---|
name | String :配置對像類型的唯一名稱。 |
configObject | Object :配置對象 |
投擲 | |
---|---|
ConfigurationException | 如果 configObject 不是正確的類型 |
設置配置對象列表
public abstract void setConfigurationObjectList (String name,configList)
為給定名稱設置配置對象列表的通用方法,替換任何現有值。
參數 | |
---|---|
name | String :配置對像類型的唯一名稱。 |
configList |
投擲 | |
---|---|
ConfigurationException | 如果列表中的任何對像不是正確的類型 |
設置覆蓋選項
public abstract void setCoverageOptions (CoverageOptions coverageOptions)
設置CoverageOptions
,替換任何現有值。
參數 | |
---|---|
coverageOptions | CoverageOptions |
設置設備配置
public abstract void setDeviceConfig (IDeviceConfiguration deviceConfig)
設置IDeviceConfiguration
,替換任何現有值。
setDeviceMetricCollectors
public abstract void setDeviceMetricCollectors (collectors)
設置IMetricCollector
的列表,替換任何現有值。
參數 | |
---|---|
collectors |
設置設備選項
public abstract void setDeviceOptions (TestDeviceOptions deviceOptions)
設置TestDeviceOptions
,替換任何現有值
參數 | |
---|---|
deviceOptions | TestDeviceOptions |
設置設備要求
public abstract void setDeviceRequirements (IDeviceSelection deviceSelection)
設置IDeviceSelection
,替換任何現有值
設置LabPreparer
public abstract void setLabPreparer (ITargetPreparer preparer)
設置ITargetPreparer
,替換任何現有值。
setMultiPreTargetPreparer
public abstract void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPreps)
在此配置中設置單個IMultiTargetPreparer
便捷方法,應在任何設備 target_preparers 之前執行,替換任何現有值
setMultiPreTargetPreparers
public abstract void setMultiPreTargetPreparers (multiPreTargPreps)
在此配置中設置IMultiTargetPreparer
的列表,該列表應在任何設備 target_preparers 之前執行,替換任何現有值
設置多目標準備器
public abstract void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)
在此配置中設置單個IMultiTargetPreparer
便捷方法,替換任何現有值
setMultiTargetPreparers
public abstract void setMultiTargetPreparers (multiTargPreps)
在此配置中設置IMultiTargetPreparer
的列表,替換任何現有值
setOptionsFromCommandLineArgs
public abstractsetOptionsFromCommandLineArgs ( listArgs)
使用給定的命令行參數集設置配置Option
字段
ArgsOptionParser
參數 | |
---|---|
listArgs |
退貨 | |
---|---|
未使用的參數 |
投擲 | |
---|---|
ConfigurationException |
setOptionsFromCommandLineArgs
public abstractsetOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用給定的命令行參數集設置配置Option
字段
ArgsOptionParser
參數 | |
---|---|
listArgs | |
keyStoreClient | IKeyStoreClient :要使用的IKeyStoreClient 。 |
退貨 | |
---|---|
未使用的參數 |
投擲 | |
---|---|
ConfigurationException |
設置重試決定
public abstract void setRetryDecision (IRetryDecision decisionRetry)
設置IRetryDecision
,替換任何現有值。
設置系統狀態檢查器
public abstract void setSystemStatusChecker (ISystemStatusChecker systemChecker)
在此配置中設置單個ISystemStatusChecker
便捷方法,替換任何現有值
設置系統狀態檢查器
public abstract void setSystemStatusCheckers (systemCheckers)
在此配置中設置ISystemStatusChecker
的列表,替換任何現有值
設置目標準備器
public abstract void setTargetPreparer (ITargetPreparer preparer)
設置ITargetPreparer
,替換任何現有值。
setTestInvocationListener
public abstract void setTestInvocationListener (ITestInvocationListener listener)
設置單個ITestInvocationListener
便捷方法
setTestInvocationListeners
public abstract void setTestInvocationListeners (listeners)
設置ITestInvocationListener
的列表,替換任何現有值