配置
public
class
Configuration
extends Object
implements
IConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.Configuration |
一个具体 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
|
NON_MODULE_OBJECTS
|
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 |
SKIP_MANAGER_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
非模块对象
public static finalNON_MODULE_OBJECTS
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
SKIP_MANAGER_TYPE_NAME
public static final String SKIP_MANAGER_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 |
公共方法
addFilesToClean
public void addFilesToClean (toBeCleaned)
添加必须在 cleanConfigurationData()
期间清理的文件
参数 | |
---|---|
toBeCleaned |
|
cleanConfigurationData
public void cleanConfigurationData ()
删除下载到远程文件的已解析选项字段中的所有文件。
dumpXml
public void dumpXml (PrintWriter output)
获取配置的展开 XML 文件,其中包含针对此配置显示的所有选项
IConfiguration
,以 String
形式表示。
参数 | |
---|---|
output |
PrintWriter :输出 xml 的写入者。 |
dumpXml
public void dumpXml (PrintWriter output,excludeFilters)
获取配置的展开式 XML 文件,其中包含为此 IConfiguration
显示的所有选项(不包括按键名称过滤的对象)。
过滤条件示例:Configuration#TARGET_PREPARER_TYPE_NAME
。
参数 | |
---|---|
output |
PrintWriter :用于将 XML 输出的写入器。 |
excludeFilters |
:不应转储的对象类型的列表。 |
dumpXml
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 |
getCommandLine
public String getCommandLine ()
获取用于创建此 IConfiguration
的命令行。
返回 | |
---|---|
String |
用于创建此 IConfiguration 的命令行。 |
getCommandOptions
public ICommandOptions getCommandOptions ()
从配置中获取要使用的 ICommandOptions
。
返回 | |
---|---|
ICommandOptions |
配置中提供的 ICommandOptions 。 |
getConfigurationDescription
public ConfigurationDescriptor getConfigurationDescription ()
返回配置中提供的 ConfigurationDescriptor
。
返回 | |
---|---|
ConfigurationDescriptor |
getConfigurationObject
public Object getConfigurationObject (String typeName)
用于获取具有给定类型名称的配置对象的通用接口。
参数 | |
---|---|
typeName |
String :配置对象的唯一类型 |
返回 | |
---|---|
Object |
配置对象,如果不存在具有给定名称的对象类型,则返回 null 。 |
getConfigurationObjectList
publicgetConfigurationObjectList (String typeName)
与 getConfigurationObject(String)
类似,但用于配置
支持多个对象的对象类型。
参数 | |
---|---|
typeName |
String :配置对象的唯一类型名称 |
返回 | |
---|---|
|
配置对象列表,如果不存在具有给定名称的对象类型,则返回 null 。 |
getCoverageOptions
public CoverageOptions getCoverageOptions ()
从配置中获取要使用的 CoverageOptions
。
返回 | |
---|---|
CoverageOptions |
配置中提供的 CoverageOptions 。 |
getDeviceConfig
publicgetDeviceConfig ()
从配置中获取 IDeviceConfiguration
。
返回 | |
---|---|
|
在配置中按顺序提供的 IDeviceConfiguration |
getDeviceConfigByName
public IDeviceConfiguration getDeviceConfigByName (String nameDevice)
返回与所提供名称关联的 IDeviceConfiguration
;如果未找到,则返回 null。
参数 | |
---|---|
nameDevice |
String |
返回 | |
---|---|
IDeviceConfiguration |
getDeviceOptions
public TestDeviceOptions getDeviceOptions ()
从配置中获取要使用的 TestDeviceOptions
。
返回 | |
---|---|
TestDeviceOptions |
配置中提供的 TestDeviceOptions 。 |
getDeviceRecovery
public IDeviceRecovery getDeviceRecovery ()
从配置中获取要使用的 IDeviceRecovery
。
返回 | |
---|---|
IDeviceRecovery |
配置中提供的 IDeviceRecovery 。 |
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
从配置中获取要使用的 IDeviceSelection
。
返回 | |
---|---|
IDeviceSelection |
配置中提供的 IDeviceSelection 。 |
getGlobalFilters
public GlobalTestFilter getGlobalFilters ()
获取调用的 GlobalTestFilter
。
返回 | |
---|---|
GlobalTestFilter |
getInopOptions
publicgetInopOptions ()
获取未更改任何值的选项名称
返回 | |
---|---|
|
getLogOutput
public ILeveledLogOutput getLogOutput ()
从配置中获取要使用的 ILeveledLogOutput
。
返回 | |
---|---|
ILeveledLogOutput |
配置中提供的 ILeveledLogOutput 。 |
getMultiDeviceSupportedTag
public staticgetMultiDeviceSupportedTag ()
返回多设备的设备标记中支持的标记的 ERROR(/Set)
配置。
返回 | |
---|---|
|
getMultiPreTargetPreparers
publicgetMultiPreTargetPreparers ()
从配置中获取应在任何设备 target_preparer 之前执行的 IMultiTargetPreparer
。
返回 | |
---|---|
|
配置中按顺序提供的 IMultiTargetPreparer |
getMultiTargetPreparers
publicgetMultiTargetPreparers ()
从配置中获取 IMultiTargetPreparer
。
返回 | |
---|---|
|
配置中按顺序提供的 IMultiTargetPreparer |
getName
public String getName ()
返回配置的名称。
返回 | |
---|---|
String |
getRetryDecision
public IRetryDecision getRetryDecision ()
返回用于调用的 IRetryDecision
。
返回 | |
---|---|
IRetryDecision |
getSystemStatusCheckers
publicgetSystemStatusCheckers ()
从配置中获取 ISystemStatusChecker
。
返回 | |
---|---|
|
配置中按顺序提供的 ISystemStatusChecker |
getTargetPreparers
publicgetTargetPreparers ()
从配置中获取 ITargetPreparer
。
返回 | |
---|---|
|
配置中按顺序提供的 ITargetPreparer |
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 |
injectOptionValues
public void injectOptionValues (optionDefs)
将多个选项值注入一组配置对象。
用于在创建新对象后一次性注入多个选项值。
参数 | |
---|---|
optionDefs |
:要注入的选项定义列表 |
抛出 | |
---|---|
ConfigurationException |
isDeviceConfiguredFake
public boolean isDeviceConfiguredFake (String deviceName)
返回已配置的设备是否标记为 isFake=true。
参数 | |
---|---|
deviceName |
String |
返回 | |
---|---|
boolean |
partialDeepClone
public IConfiguration partialDeepClone (objectToDeepClone, IKeyStoreClient client)
从 clone()
创建基础克隆,然后深度克隆给定配置对象的列表。
参数 | |
---|---|
objectToDeepClone |
:要深层克隆的配置对象列表。 |
client |
IKeyStoreClient :密钥库客户端。 |
返回 | |
---|---|
IConfiguration |
部分深层克隆的配置。 |
抛出 | |
---|---|
ConfigurationException |
printCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
将此配置的命令行使用情况帮助文本输出到给定 printStream。
参数 | |
---|---|
importantOnly |
boolean :如果 true 仅输出重要选项的帮助信息 |
out |
PrintStream :要使用的 ERROR(/PrintStream) 。 |
抛出 | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
resolveDynamicOptions
public void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
解析指向远程位置的 ERROR(/File)
选项。这需要调用 cleanConfigurationData()
来清理文件。
参数 | |
---|---|
resolver |
DynamicRemoteFileResolver :用于解析文件的 DynamicRemoteFileResolver |
抛出 | |
---|---|
BuildRetrievalError |
|
ConfigurationException |
safeInjectOptionValues
public void safeInjectOptionValues (optionDefs)
将多个选项值注入到一组配置对象中,如果存在,则抛出 无法应用此选项。
用于在创建新对象后一次性注入多个选项值。
参数 | |
---|---|
optionDefs |
:要注入的选项定义列表 |
抛出 | |
---|---|
ConfigurationException |
setBestEffortOptionsFromCommandLineArgs
publicsetBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用尽可能的方法,使用给定的一组命令行参数设置配置 Option
字段。
如需了解预期格式,请参阅 ArgsOptionParser
参数 | |
---|---|
listArgs |
:命令行参数 |
keyStoreClient |
IKeyStoreClient :要使用的 IKeyStoreClient 。 |
返回 | |
---|---|
|
不使用的参数 |
抛出 | |
---|---|
ConfigurationException |
setBuildProvider
public void setBuildProvider (IBuildProvider provider)
替换配置中的当前 IBuildProvider
。
参数 | |
---|---|
provider |
IBuildProvider :新的 IBuildProvider |
setCommandLine
public void setCommandLine (String[] arrayArgs)
设置用于创建此 IConfiguration
的命令行。
这会存储整个命令行,包括配置名称、
与 setOptionsFromCommandLineArgs 不同。
参数 | |
---|---|
arrayArgs |
String :命令行 |
setCommandOptions
public void setCommandOptions (ICommandOptions cmdOptions)
设置 ICommandOptions
,替换所有现有值
setConfigurationObject
public void setConfigurationObject (String typeName, Object configObject)
使用给定名称设置配置对象的通用方法,替换任何现有值。
参数 | |
---|---|
typeName |
String :配置对象类型的唯一名称。 |
configObject |
Object :配置对象 |
抛出 | |
---|---|
ConfigurationException |
setConfigurationObjectList
public void setConfigurationObjectList (String typeName,configList)
用于为给定名称设置配置对象列表的通用方法,会替换任何现有值。
参数 | |
---|---|
typeName |
String :配置对象类型的唯一名称。 |
configList |
:配置对象列表 |
抛出 | |
---|---|
ConfigurationException |
setCoverageOptions
public void setCoverageOptions (CoverageOptions coverageOptions)
设置 CoverageOptions
,替换任何现有值。
参数 | |
---|---|
coverageOptions |
CoverageOptions |
setDeviceConfig
public void setDeviceConfig (IDeviceConfiguration deviceConfig)
设置 IDeviceConfiguration
,替换任何现有值。
setDeviceConfigList
public void setDeviceConfigList (deviceConfigs)
设置 IDeviceConfiguration
,替换任何现有值。
setDeviceMetricCollector
public void setDeviceMetricCollectors (collectors)
设置 IMetricCollector
列表,替换所有现有值。
参数 | |
---|---|
collectors |
|
setDeviceOptions
public void setDeviceOptions (TestDeviceOptions devOptions)
设置 TestDeviceOptions
,替换所有现有值
参数 | |
---|---|
devOptions |
TestDeviceOptions |
setDeviceRecovery
public void setDeviceRecovery (IDeviceRecovery recovery)
设置 IDeviceRecovery
,替换任何现有值。
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
设置 IDeviceSelection
,替换任何现有值
setMultiPreTargetPreparer
public void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPrep)
一种便捷方法,用于在此配置中设置单个 IMultiTargetPreparer
,该 IMultiTargetPreparer
应在任何设备 target_preparer 之前执行,并替换所有现有值
setMultiPreTargetPreparers
public void setMultiPreTargetPreparers (multiPreTargPreps)
在此配置中设置应在任何设备 target_preparer 之前执行的 IMultiTargetPreparer
列表,替换所有现有值
setMultiTargetPreparer
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 |
setPostProcessors
public void setPostProcessors (processors)
设置 IPostProcessor
列表,替换任何现有值。
参数 | |
---|---|
processors |
|
setRetryDecision
public void setRetryDecision (IRetryDecision decisionRetry)
设置 IRetryDecision
,替换任何现有值。
setSystemStatusChecker
public void setSystemStatusChecker (ISystemStatusChecker systemChecker)
在此配置中设置单个 ISystemStatusChecker
的便捷方法,
替换任何现有值
setSystemStatusCheckers
public void setSystemStatusCheckers (systemCheckers)
在此配置中设置 ISystemStatusChecker
列表,替换所有现有值
setTargetPreparer
public void setTargetPreparer (ITargetPreparer preparer)
设置 ITargetPreparer
,替换任何现有值。
setTestInvocationListener
public void setTestInvocationListener (ITestInvocationListener listener)
用于设置单个 ITestInvocationListener
的便捷方法
setTestInvocationListeners
public void setTestInvocationListeners (listeners)
设置 ITestInvocationListener
列表,替换任何现有值
受保护的方法
远程环境
protected boolean isRemoteEnvironment ()
返回 TF 环境是否为远程调用。
返回 | |
---|---|
boolean |