配置
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
SANDBOX_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
测试类型名称
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 文件,其中包含此IConfiguration
以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 |
获取所有配置对象类型
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 |