Google 致力于为黑人社区推动种族平等。查看具体举措
此页面由 Cloud Translation API 翻译。
Switch to English

配置

public interface IConfiguration

com.android.tradefed.config.IConfiguration


TradeFederation调用的配置信息。每个TradeFederation调用都有一个IConfigurationIConfiguration存储应在调用期间使用的所有委托对象及其关联的Option

摘要

公开方法

abstract void cleanDynamicOptionFiles ()

删除所有已下载到远程文件的已解决选项字段中的文件。

abstract IConfiguration clone ()

创建此对象的浅表副本。

abstract void dumpXml (PrintWriter output)

获取配置的扩展XML文件,该IConfigurationString显示所有选项。

abstract void dumpXml (PrintWriter output, excludeFilters) dumpXml (PrintWriter output, excludeFilters)

获取此配置的扩展XML文件,其中显示了此IConfiguration所有选项,减去对象筛选器的键名。

abstract void dumpXml (PrintWriter output, excludeFilters, boolean printDeprecatedOptions) dumpXml (PrintWriter output, excludeFilters, boolean printDeprecatedOptions)

获取此配置的扩展XML文件,其中显示了此IConfiguration所有选项,减去对象筛选器的键名。

abstract getAllConfigurationObjectsOfType (String typeName)

通用接口,用于在设备之间获取一种给定类型名称的所有对象。

abstract IBuildProvider getBuildProvider ()

从配置中获取IBuildProvider

abstract String getCommandLine ()

获取用于创建此IConfiguration的命令行。

abstract ICommandOptions getCommandOptions ()

从配置中获取要使用的ICommandOptions

abstract ConfigurationDescriptor getConfigurationDescription ()

返回ConfigurationDescriptor提供的ConfigurationDescriptor。

abstract Object getConfigurationObject (String typeName)

通用接口,用于获取具有给定类型名称的配置对象。

abstract getConfigurationObjectList (String typeName)

getConfigurationObject(String)类似,但适用于支持多个对象的配置对象类型。

abstract getDeviceConfig ()

从配置中获取IDeviceConfiguration

abstract IDeviceConfiguration getDeviceConfigByName (String nameDevice)

返回与提供的名称关联的IDeviceConfiguration ,如果找不到,则返回null。

abstract TestDeviceOptions getDeviceOptions ()

从配置中获取要使用的TestDeviceOptions

abstract IDeviceRecovery getDeviceRecovery ()

从配置中获取要使用的IDeviceRecovery

abstract IDeviceSelection getDeviceRequirements ()

从配置中获取要使用的IDeviceSelection

abstract DeviceSideCollectorSpecification getDeviceSideCollectorsSpec ()

获取DeviceSideCollectorSpecification驱动收集器的设备/目标端规范及其选项。

abstract JSONArray getJsonCommandUsage ()

返回此配置的JSON表示形式。

abstract ILeveledLogOutput getLogOutput ()

从配置中获取要使用的ILeveledLogOutput

abstract ILogSaver getLogSaver ()

从配置中获取要使用的ILogSaver

abstract getMetricCollectors ()

从配置中获取IMetricCollector

abstract getMultiPreTargetPreparers ()

从应该在任何设备target_preparers之前执行的配置中获取IMultiTargetPreparer

abstract getMultiTargetPreparers ()

从配置中获取IMultiTargetPreparer

abstract String getName ()

返回配置的名称。

abstract getPostProcessors ()

从配置中获取IPostProcessor

abstract getSystemStatusCheckers ()

从配置中获取ISystemStatusChecker

abstract getTargetPreparers ()

从配置中获取ITargetPreparer

abstract getTestInvocationListeners ()

从配置中获取要使用的ITestInvocationListener

abstract getTests ()

从配置中获取要运行的IRemoteTest

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 void printCommandUsage (boolean importantOnly, PrintStream out)

将此配置的命令行用法帮助文本输出到给定的printStream。

abstract void setBuildProvider ( IBuildProvider provider)

在配置中替换当前的IBuildProvider

abstract void setCommandLine (String[] arrayArgs)

设置用于创建此IConfiguration的命令行。

abstract void setCommandOptions ( ICommandOptions cmdOptions)

设置ICommandOptions ,替换所有现有值

abstract void setConfigurationObject (String name, Object configObject)

用给定名称设置config对象的通用方法,替换任何现有值。

abstract void setConfigurationObjectList (String name, configList) setConfigurationObjectList (String name, configList)

设置给定名称的配置对象列表的通用方法,替换任何现有值。

abstract void setDeviceConfig ( IDeviceConfiguration deviceConfig)

设置IDeviceConfiguration ,替换任何现有值。

abstract void setDeviceConfigList ( deviceConfigs) setDeviceConfigList ( deviceConfigs)

设置IDeviceConfiguration ,替换任何现有值。

abstract void setDeviceMetricCollectors ( collectors) setDeviceMetricCollectors ( collectors)

设置IMetricCollector的列表,替换所有现有值。

abstract void setDeviceOptions ( TestDeviceOptions deviceOptions)

设置TestDeviceOptions ,替换所有现有值

abstract void setDeviceRecovery ( IDeviceRecovery recovery)

设置IDeviceRecovery ,替换任何现有值。

abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

设置IDeviceSelection ,替换所有现有值

abstract void setDeviceSideCollectorSpec ( DeviceSideCollectorSpecification deviceCollectorSpec)

设置DeviceSideCollectorSpecification ,替换所有现有值。

abstract void setLogOutput ( ILeveledLogOutput logger)

设置ILeveledLogOutput ,替换任何现有值。

abstract void setLogSaver ( ILogSaver logSaver)

设置ILogSaver ,替换任何现有值。

abstract void setMultiPreTargetPreparer ( IMultiTargetPreparer multiPreTargPreps)

在此配置中设置单个IMultiTargetPreparer便捷方法,该方法应在任何设备target_preparers之前执行,以替换任何现有值

abstract void setMultiPreTargetPreparers ( multiPreTargPreps) setMultiPreTargetPreparers ( multiPreTargPreps)

在此配置中设置IMultiTargetPreparer的列表,该列表应在任何设备target_preparers之前执行,以替换任何现有值

abstract void setMultiTargetPreparer ( IMultiTargetPreparer multiTargPrep)

在此配置中设置单个IMultiTargetPreparer便捷方法,替换任何现有值

abstract void setMultiTargetPreparers ( multiTargPreps) setMultiTargetPreparers ( multiTargPreps)

在此配置中设置IMultiTargetPreparer的列表,替换所有现有值

abstract setOptionsFromCommandLineArgs ( listArgs) setOptionsFromCommandLineArgs ( listArgs)

使用给定的命令行参数集设置配置Option字段

预期格式的ArgsOptionParser

abstract setOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient) setOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)

使用给定的命令行参数集设置配置Option字段

请参阅ArgsOptionParser以获取预期格式

abstract void setPostProcessors ( processors) setPostProcessors ( processors)

设置IPostProcessor的列表,替换所有现有值。

abstract void setSystemStatusChecker ( ISystemStatusChecker systemChecker)

在此配置中设置单个ISystemStatusChecker便捷方法,替换任何现有值

abstract void setSystemStatusCheckers ( systemCheckers) setSystemStatusCheckers ( systemCheckers)

在此配置中设置ISystemStatusChecker的列表,替换所有现有值

abstract void setTargetPreparer ( ITargetPreparer preparer)

设置ITargetPreparer ,替换任何现有值。

abstract void setTargetPreparers ( preparers) setTargetPreparers ( preparers)

设置ITargetPreparer的列表,替换任何现有值。

abstract void setTest ( IRemoteTest test)

在此配置中设置单个IRemoteTest便捷方法,替换任何现有值

abstract void setTestInvocationListener ( ITestInvocationListener listener)

设置单个ITestInvocationListener便捷方法

abstract void setTestInvocationListeners ( listeners) setTestInvocationListeners ( listeners)

设置ITestInvocationListener的列表,替换所有现有值

abstract void setTests ( tests) setTests ( tests)

在此配置中设置IRemoteTest的列表,替换所有现有值

abstract void validateOptions ()

验证选项值。

abstract void validateOptions (boolean download)

验证选项值。

公开方法

cleanDynamicOptionFiles

public abstract void cleanDynamicOptionFiles ()

删除所有已下载到远程文件的已解决选项字段中的文件。

克隆

public abstract IConfiguration clone ()

创建此对象的浅表副本。

退货
IConfiguration {link IConfiguration}副本

dumpXml

public abstract void dumpXml (PrintWriter output)

获取配置的扩展XML文件,该IConfigurationString显示所有选项。

参量
output PrintWriter :将xml打印到的作家。

dumpXml

public abstract void dumpXml (PrintWriter output, 
                 excludeFilters)

获取此配置的扩展XML文件,其中显示了此IConfiguration所有选项,减去对象筛选器的键名。

过滤器示例: Configuration#TARGET_PREPARER_TYPE_NAME

参量
output PrintWriter :将xml打印到的作家。

excludeFilters :不应转储的对象类型的列表。

dumpXml

public abstract void dumpXml (PrintWriter output, 
                 excludeFilters, 
                boolean printDeprecatedOptions)

获取此配置的扩展XML文件,其中显示了此IConfiguration所有选项,减去对象筛选器的键名。

过滤器示例: Configuration#TARGET_PREPARER_TYPE_NAME

参量
output PrintWriter :将xml打印到的作家。

excludeFilters :不应转储的对象类型的列表。

printDeprecatedOptions boolean :是否打印标记为不推荐使用的选项

getAllConfigurationObjectsOfType

public abstract  getAllConfigurationObjectsOfType (String typeName)

通用接口,用于跨设备获取一种给定类型名称的所有对象。

参量
typeName String :配置对象的唯一类型

退货
给定类型的配置对象列表。

getBuildProvider

public abstract IBuildProvider getBuildProvider ()

从配置中获取IBuildProvider

退货
IBuildProvider 配置中提供的IBuildProvider

getCommandLine

public abstract String getCommandLine ()

获取用于创建此IConfiguration的命令行。

退货
String 用于创建此IConfiguration的命令行。

getCommandOptions

public abstract ICommandOptions getCommandOptions ()

从配置中获取要使用的ICommandOptions

退货
ICommandOptions 配置中提供的ICommandOptions

getConfigurationDescription

public abstract ConfigurationDescriptor getConfigurationDescription ()

返回ConfigurationDescriptor提供的ConfigurationDescriptor。

退货
ConfigurationDescriptor

getConfigurationObject

public abstract Object getConfigurationObject (String typeName)

通用接口,用于获取具有给定类型名称的配置对象。

参量
typeName String :配置对象的唯一类型

退货
Object 配置对象;如果不存在具有给定名称的对象类型,则为null

getConfigurationObjectList

public abstract  getConfigurationObjectList (String typeName)

getConfigurationObject(String)类似,但适用于支持多个对象的配置对象类型。

参量
typeName String :配置对象的唯一类型名称

退货
配置对象列表;如果不存在具有给定名称的对象类型,则为null

getDeviceConfig

public abstract  getDeviceConfig ()

从配置中获取IDeviceConfiguration

退货
在配置中按顺序提供的IDeviceConfiguration

getDeviceConfigByName

public abstract IDeviceConfiguration getDeviceConfigByName (String nameDevice)

返回与提供的名称关联的IDeviceConfiguration ,如果找不到,则返回null。

参量
nameDevice String

退货
IDeviceConfiguration

getDeviceOptions

public abstract TestDeviceOptions getDeviceOptions ()

从配置中获取要使用的TestDeviceOptions

退货
TestDeviceOptions 配置中提供的TestDeviceOptions

getDeviceRecovery

public abstract IDeviceRecovery getDeviceRecovery ()

从配置中获取要使用的IDeviceRecovery

退货
IDeviceRecovery 配置中提供的IDeviceRecovery

getDeviceRequirements

public abstract IDeviceSelection getDeviceRequirements ()

从配置中获取要使用的IDeviceSelection

退货
IDeviceSelection 配置中提供的IDeviceSelection

getDeviceSideCollectorsSpec

public abstract DeviceSideCollectorSpecification getDeviceSideCollectorsSpec ()

获取DeviceSideCollectorSpecification驱动收集器的设备/目标端规范及其选项。

退货
DeviceSideCollectorSpecification

getJsonCommandUsage

public abstract JSONArray getJsonCommandUsage ()

返回此配置的JSON表示形式。

返回值是一个JSONArray,其中包含表示每个配置对象的JSONObjects。每个配置对象条目具有以下结构:

 {
     "alias": "device-unavail-email",
     "name": "result_reporter",
     "class": "com.android.tradefed.result.DeviceUnavailEmailResultReporter",
     "options": [ ... ]
   }
 
 
“选项”条目是一个JSONArray,其中包含表示每个@Option带注释字段的JSONObject。每个选项条目具有以下结构:
 {
     "updateRule": "LAST",
     "isTimeVal": false,
     "source": "google\/template\/reporters\/asit",
     "importance": "IF_UNSET",
     "description": "The envelope-sender address to use for the messages.",
     "mandatory": false,
     "name": "sender",
     "javaClass": "java.lang.String",
     "value": "tffail@google.com"
   }
 
 
大多数值来自@Option批注。 “ javaClass”是此选项的基础Java类的名称。 “值”是字段当前值的JSON表示形式。 “源”是一组配置名称,用于设置字段的值。对于常规对象或集合,“源”是一个JSONArray,其中包含每个贡献配置的名称。对于地图字段,每个键的源都会单独跟踪并存储在JSONObject中。 JSONObject中的每个键/值对都对应于映射中的键及其源配置数组。

退货
JSONArray

投掷
JSONException

getLogOutput

public abstract ILeveledLogOutput getLogOutput ()

从配置中获取要使用的ILeveledLogOutput

退货
ILeveledLogOutput 配置中提供的ILeveledLogOutput

getLogSaver

public abstract ILogSaver getLogSaver ()

从配置中获取要使用的ILogSaver

退货
ILogSaver 配置中提供的ILogSaver

getMetricCollectors

public abstract  getMetricCollectors ()

从配置中获取IMetricCollector

退货

getMultiPreTargetPreparers

public abstract  getMultiPreTargetPreparers ()

从应该在任何设备target_preparers之前执行的配置中获取IMultiTargetPreparer

退货
在配置中按顺序提供的IMultiTargetPreparer

getMultiTargetPreparers

public abstract  getMultiTargetPreparers ()

从配置中获取IMultiTargetPreparer

退货
在配置中按顺序提供的IMultiTargetPreparer

getName

public abstract String getName ()

返回配置的名称。

退货
String

getPostProcessors

public abstract  getPostProcessors ()

从配置中获取IPostProcessor

退货

getSystemStatusCheckers

public abstract  getSystemStatusCheckers ()

从配置中获取ISystemStatusChecker

退货
配置中按顺序提供的ISystemStatusChecker

getTargetPreparers

public abstract  getTargetPreparers ()

从配置中获取ITargetPreparer

退货
在配置中按顺序提供的ITargetPreparer

getTestInvocationListeners

public abstract  getTestInvocationListeners ()

从配置中获取要使用的ITestInvocationListener

退货
配置中提供的ITestInvocationListener

getTests

public abstract  getTests ()

从配置中获取要运行的IRemoteTest

退货
配置中提供的测试

injectOptionValue

public abstract void injectOptionValue (String optionName, 
                String optionValue)

将选项值注入到配置对象集中。

为动态生成的选项提供值很有用。

参量
optionName String :选项名称

optionValue String :选项值

投掷
ConfigurationException 如果无法设置选项的值

injectOptionValue

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 如果无法设置选项的值

injectOptionValues

public abstract void injectOptionValues ( optionDefs)

将多个选项值注入到配置对象集中。

创建新对象后立即注入许多选项值很有用。

参量
optionDefs :要插入的选项定义列表

投掷
ConfigurationException 如果无法设置选项值

isDeviceConfiguredFake

public abstract boolean isDeviceConfiguredFake (String deviceName)

返回是否标记了已配置的设备isFake = true。

参量
deviceName String

退货
boolean

printCommandUsage

public abstract void printCommandUsage (boolean importantOnly, 
                PrintStream out)

将此配置的命令行用法帮助文本输出到给定的printStream。

参量
importantOnly boolean :如果为true仅打印重要选项的帮助

out PrintStream :要使用的ERROR(/PrintStream)

投掷
ConfigurationException

setBuildProvider

public abstract void setBuildProvider ( IBuildProvider provider)

在配置中替换当前的IBuildProvider

参量
provider IBuildProvider :新的IBuildProvider

setCommandLine

public abstract void setCommandLine (String[] arrayArgs)

设置用于创建此IConfiguration的命令行。与setOptionsFromCommandLineArgs不同,这将存储整个命令行,包括配置名称。

参量
arrayArgs String :命令行

setCommandOptions

public abstract void setCommandOptions ( ICommandOptions cmdOptions)

设置ICommandOptions ,替换所有现有值

setConfigurationObject

public abstract void setConfigurationObject (String name, 
                Object configObject)

用给定名称设置config对象的通用方法,替换任何现有值。

参量
name String :配置对象类型的唯一名称。

configObject Object :配置对象

投掷
ConfigurationException 如果configObject不是正确的类型

setConfigurationObjectList

public abstract void setConfigurationObjectList (String name, 
                 configList)

设置给定名称的配置对象列表的通用方法,替换任何现有值。

参量
name String :配置对象类型的唯一名称。

configList :配置对象列表

投掷
ConfigurationException 如果列表中的任何对象不是正确的类型

setDeviceConfig

public abstract void setDeviceConfig ( IDeviceConfiguration deviceConfig)

设置IDeviceConfiguration ,替换任何现有值。

setDeviceConfigList

public abstract void setDeviceConfigList ( deviceConfigs)

设置IDeviceConfiguration ,替换任何现有值。

setDeviceMetricCollectors

public abstract void setDeviceMetricCollectors ( collectors)

设置IMetricCollector的列表,替换所有现有值。

参量
collectors

setDeviceOptions

public abstract void setDeviceOptions ( TestDeviceOptions deviceOptions)

设置TestDeviceOptions ,替换所有现有值

参量
deviceOptions TestDeviceOptions

setDeviceRecovery

public abstract void setDeviceRecovery ( IDeviceRecovery recovery)

设置IDeviceRecovery ,替换任何现有值。

setDeviceRequirements

public abstract void setDeviceRequirements ( IDeviceSelection deviceSelection)

设置IDeviceSelection ,替换所有现有值

setDeviceSideCollectorSpec

public abstract void setDeviceSideCollectorSpec ( DeviceSideCollectorSpecification deviceCollectorSpec)

设置DeviceSideCollectorSpecification ,替换所有现有值。

参量
deviceCollectorSpec DeviceSideCollectorSpecification

setLogOutput

public abstract void setLogOutput ( ILeveledLogOutput logger)

设置ILeveledLogOutput ,替换任何现有值。

setLogSaver

public abstract void setLogSaver ( ILogSaver logSaver)

设置ILogSaver ,替换任何现有值。

setMultiPreTargetPreparer

public abstract void setMultiPreTargetPreparer ( IMultiTargetPreparer multiPreTargPreps)

在此配置中设置单个IMultiTargetPreparer便捷方法,该方法应在任何设备target_preparers之前执行,以替换任何现有值

setMultiPreTargetPreparers

public abstract void setMultiPreTargetPreparers ( multiPreTargPreps)

在此配置中设置IMultiTargetPreparer的列表,该列表应在任何设备target_preparers之前执行,以替换任何现有值

setMultiTargetPreparer

public abstract void setMultiTargetPreparer ( IMultiTargetPreparer multiTargPrep)

在此配置中设置单个IMultiTargetPreparer便捷方法,替换任何现有值

setMultiTargetPreparers

public abstract void setMultiTargetPreparers ( multiTargPreps)

在此配置中设置IMultiTargetPreparer的列表,替换所有现有值

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs)

使用给定的命令行参数集设置配置Option字段

预期格式的ArgsOptionParser

参量
listArgs :命令行参数

退货
未消费的论点

投掷
ConfigurationException

setOptionsFromCommandLineArgs

public abstract  setOptionsFromCommandLineArgs ( listArgs, 
                IKeyStoreClient keyStoreClient)

使用给定的命令行参数集设置配置Option字段

请参阅ArgsOptionParser以获取预期格式

参量
listArgs :命令行参数

keyStoreClient IKeyStoreClient :要使用的IKeyStoreClient

退货
未消费的论点

投掷
ConfigurationException

setPostProcessors

public abstract void setPostProcessors ( processors)

设置IPostProcessor的列表,替换所有现有值。

参量
processors

setSystemStatusChecker

public abstract void setSystemStatusChecker ( ISystemStatusChecker systemChecker)

在此配置中设置单个ISystemStatusChecker便捷方法,替换任何现有值

setSystemStatusCheckers

public abstract void setSystemStatusCheckers ( systemCheckers)

在此配置中设置ISystemStatusChecker的列表,替换所有现有值

setTargetPreparer

public abstract void setTargetPreparer ( ITargetPreparer preparer)

设置ITargetPreparer ,替换任何现有值。

setTargetPreparers

public abstract void setTargetPreparers ( preparers)

设置ITargetPreparer的列表,替换任何现有值。

setTest

public abstract void setTest ( IRemoteTest test)

在此配置中设置单个IRemoteTest便捷方法,替换任何现有值

setTestInvocationListener

public abstract void setTestInvocationListener ( ITestInvocationListener listener)

设置单个ITestInvocationListener便捷方法

setTestInvocationListeners

public abstract void setTestInvocationListeners ( listeners)

设置ITestInvocationListener的列表,替换所有现有值

setTests

public abstract void setTests ( tests)

在此配置中设置IRemoteTest的列表,替换所有现有值

validateOptions

public abstract void validateOptions ()

验证选项值。

目前,这只会验证所有必填选项已设置

投掷
ConfigurationException 如果config无效

validateOptions

public abstract void validateOptions (boolean download)

验证选项值。

目前,这只会验证所有必填选项已设置

参量
download boolean :是否下载与远程路径关联的文件

投掷
ConfigurationException 如果config无效