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
的列表,替换任何现有值