配置
public
class
Configuration
extends Object
implements
IConfiguration
| java.lang.Object | |
| ↳ | com.android.tradefed.config.Configuration |
一种具体的 IConfiguration 实现,用于将加载的配置对象存储在映射中。
摘要
常量 | |
|---|---|
String |
BUILD_PROVIDER_TYPE_NAME
|
String |
CMD_OPTIONS_TYPE_NAME
|
String |
CONFIGURATION_DESCRIPTION_TYPE_NAME
|
String |
COVERAGE_OPTIONS_TYPE_NAME
|
String |
DEVICE_METRICS_COLLECTOR_TYPE_NAME
|
String |
DEVICE_NAME
|
String |
DEVICE_OPTIONS_TYPE_NAME
|
String |
DEVICE_RECOVERY_TYPE_NAME
|
String |
DEVICE_REQUIREMENTS_TYPE_NAME
|
String |
GLOBAL_FILTERS_TYPE_NAME
|
String |
LAB_PREPARER_TYPE_NAME
|
String |
LOGGER_TYPE_NAME
|
String |
LOG_SAVER_TYPE_NAME
|
String |
METRIC_POST_PROCESSOR_TYPE_NAME
|
String |
MULTI_PREPARER_TYPE_NAME
|
String |
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
|
String |
RESULT_REPORTER_TYPE_NAME
|
String |
RETRY_DECISION_TYPE_NAME
|
String |
SANBOX_OPTIONS_TYPE_NAME
|
String |
SANDBOX_TYPE_NAME
|
String |
SKIP_MANAGER_TYPE_NAME
|
String |
SYSTEM_STATUS_CHECKER_TYPE_NAME
|
String |
TARGET_PREPARER_TYPE_NAME
|
String |
TEST_TYPE_NAME
|
字段 | |
|---|---|
public
static
final
Set<String> |
NON_MODULE_OBJECTS
|
公共构造函数 | |
|---|---|
Configuration(String name, String description)
使用默认配置对象创建 |
|
受保护的方法 | |
|---|---|
boolean
|
isRemoteEnvironment()
返回 TF 的环境是否为远程调用。 |
常量
BUILD_PROVIDER_TYPE_NAME
public static final String BUILD_PROVIDER_TYPE_NAME
常量值: "build_provider"
CMD_OPTIONS_TYPE_NAME
public static final String CMD_OPTIONS_TYPE_NAME
常量值: "cmd_options"
CONFIGURATION_DESCRIPTION_TYPE_NAME
public static final String CONFIGURATION_DESCRIPTION_TYPE_NAME
常量值: "config_desc"
COVERAGE_OPTIONS_TYPE_NAME
public static final String COVERAGE_OPTIONS_TYPE_NAME
常量值: "coverage"
DEVICE_METRICS_COLLECTOR_TYPE_NAME
public static final String DEVICE_METRICS_COLLECTOR_TYPE_NAME
常量值: "metrics_collector"
DEVICE_NAME
public static final String DEVICE_NAME
常量值: "device"
DEVICE_OPTIONS_TYPE_NAME
public static final String DEVICE_OPTIONS_TYPE_NAME
常量值: "device_options"
DEVICE_RECOVERY_TYPE_NAME
public static final String DEVICE_RECOVERY_TYPE_NAME
常量值: "device_recovery"
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
常量值: "device_requirements"
GLOBAL_FILTERS_TYPE_NAME
public static final String GLOBAL_FILTERS_TYPE_NAME
常量值: "global_filters"
LAB_PREPARER_TYPE_NAME
public static final String LAB_PREPARER_TYPE_NAME
常量值: "lab_preparer"
LOGGER_TYPE_NAME
public static final String LOGGER_TYPE_NAME
常量值: "logger"
LOG_SAVER_TYPE_NAME
public static final String LOG_SAVER_TYPE_NAME
常量值: “log_saver”
METRIC_POST_PROCESSOR_TYPE_NAME
public static final String METRIC_POST_PROCESSOR_TYPE_NAME
常量值: "metric_post_processor"
MULTI_PREPARER_TYPE_NAME
public static final String MULTI_PREPARER_TYPE_NAME
常量值: "multi_target_preparer"
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
public static final String MULTI_PRE_TARGET_PREPARER_TYPE_NAME
常量值: "multi_pre_target_preparer"
RESULT_REPORTER_TYPE_NAME
public static final String RESULT_REPORTER_TYPE_NAME
常量值: "result_reporter"
RETRY_DECISION_TYPE_NAME
public static final String RETRY_DECISION_TYPE_NAME
常量值: "retry_decision"
SANBOX_OPTIONS_TYPE_NAME
public static final String SANBOX_OPTIONS_TYPE_NAME
常量值: "sandbox_options"
SANDBOX_TYPE_NAME
public static final String SANDBOX_TYPE_NAME
常量值: "sandbox"
SKIP_MANAGER_TYPE_NAME
public static final String SKIP_MANAGER_TYPE_NAME
常量值: "skip_manager"
SYSTEM_STATUS_CHECKER_TYPE_NAME
public static final String SYSTEM_STATUS_CHECKER_TYPE_NAME
常量值: “system_checker”
TARGET_PREPARER_TYPE_NAME
public static final String TARGET_PREPARER_TYPE_NAME
常量值: "target_preparer"
TEST_TYPE_NAME
public static final String TEST_TYPE_NAME
常量值: "test"
字段
NON_MODULE_OBJECTS
public static final Set<String> NON_MODULE_OBJECTS
公共构造函数
配置
public Configuration (String name,
String description)使用默认配置对象创建 Configuration。
| 参数 | |
|---|---|
name |
String |
description |
String |
公共方法
addFilesToClean
public void addFilesToClean (Set<File> toBeCleaned)
添加在 cleanConfigurationData() 期间必须清理的文件
| 参数 | |
|---|---|
toBeCleaned |
Set |
cleanConfigurationData
public void cleanConfigurationData ()
删除已下载到远程文件的已解析 Option 字段中的所有文件。
dumpXml
public void dumpXml (PrintWriter output)
获取配置的展开 XML 文件,其中显示了相应 IConfiguration 的所有选项,以 String 形式呈现。
| 参数 | |
|---|---|
output |
PrintWriter:用于将 XML 打印到的写入器。 |
| 抛出 | |
|---|---|
IOException |
|
dumpXml
public void dumpXml (PrintWriter output,
List<String> excludeFilters)获取配置的展开 XML 文件,其中显示了此 IConfiguration 的所有选项,但按键名称过滤的对象除外。
过滤条件示例:Configuration.TARGET_PREPARER_TYPE_NAME。
| 参数 | |
|---|---|
output |
PrintWriter:用于将 XML 打印到的写入器。 |
excludeFilters |
List:不应转储的对象类型的列表。 |
| 抛出 | |
|---|---|
IOException |
|
dumpXml
public void dumpXml (PrintWriter output,
List<String> excludeFilters,
boolean printDeprecatedOptions,
boolean printUnchangedOptions)获取配置的展开 XML 文件,其中显示了此 IConfiguration 的所有选项,但按键名称过滤的对象除外。
过滤条件示例:Configuration.TARGET_PREPARER_TYPE_NAME。
| 参数 | |
|---|---|
output |
PrintWriter:用于将 XML 打印到的写入器。 |
excludeFilters |
List:不应转储的对象类型的列表。 |
printDeprecatedOptions |
boolean:是否打印标记为已弃用的选项 |
printUnchangedOptions |
boolean |
| 抛出 | |
|---|---|
IOException |
|
getAllConfigurationObjectsOfType
public Collection<Object> getAllConfigurationObjectsOfType (String configType)
用于获取跨设备的所有给定类型名称的对象的通用接口。
| 参数 | |
|---|---|
configType |
String:配置对象的唯一类型 |
| 返回 | |
|---|---|
Collection<Object> |
指定类型的配置对象列表。 |
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
public List<?> getConfigurationObjectList (String typeName)
与 getConfigurationObject(String) 类似,但适用于支持多个对象的配置对象类型。
| 参数 | |
|---|---|
typeName |
String:配置对象的唯一类型名称 |
| 返回 | |
|---|---|
List<?> |
配置对象的列表;如果具有指定名称的对象类型不存在,则返回 null。 |
getCoverageOptions
public CoverageOptions getCoverageOptions ()
从配置中获取要使用的 CoverageOptions。
| 返回 | |
|---|---|
CoverageOptions |
配置中提供的 CoverageOptions。 |
getDeviceConfig
public List<IDeviceConfiguration> getDeviceConfig ()
从配置中获取 IDeviceConfiguration。
| 返回 | |
|---|---|
List<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。 |
getFilesToClean
public Set<File> getFilesToClean ()
获取在 cleanConfigurationData() 期间将清理的文件列表
| 返回 | |
|---|---|
Set<File> |
|
getGlobalFilters
public GlobalTestFilter getGlobalFilters ()
获取调用的 GlobalTestFilter。
| 返回 | |
|---|---|
GlobalTestFilter |
|
getInopOptions
public Set<String> getInopOptions ()
获取未更改任何值的选项名称
| 返回 | |
|---|---|
Set<String> |
|
getLabPreparers
public List<ITargetPreparer> getLabPreparers ()
从配置中获取 ITargetPreparer。
| 返回 | |
|---|---|
List<ITargetPreparer> |
按顺序在配置中提供的 ITargetPreparer |
getLogOutput
public ILeveledLogOutput getLogOutput ()
从配置中获取要使用的 ILeveledLogOutput。
| 返回 | |
|---|---|
ILeveledLogOutput |
配置中提供的 ILeveledLogOutput。 |
getMetricCollectors
public List<IMetricCollector> getMetricCollectors ()
从配置中获取 IMetricCollector。
| 返回 | |
|---|---|
List<IMetricCollector> |
|
getMultiDeviceSupportedTag
public static Set<String> getMultiDeviceSupportedTag ()
返回设备标记中支持的标记的 Set,用于多设备配置。
| 返回 | |
|---|---|
Set<String> |
|
getMultiPreTargetPreparers
public List<IMultiTargetPreparer> getMultiPreTargetPreparers ()
从配置中获取应在任何设备 target_preparer 之前执行的 IMultiTargetPreparer。
| 返回 | |
|---|---|
List<IMultiTargetPreparer> |
按顺序在配置中提供的 IMultiTargetPreparer |
getMultiTargetPreparers
public List<IMultiTargetPreparer> getMultiTargetPreparers ()
从配置中获取 IMultiTargetPreparer。
| 返回 | |
|---|---|
List<IMultiTargetPreparer> |
按顺序在配置中提供的 IMultiTargetPreparer |
getName
public String getName ()
返回配置的名称。
| 返回 | |
|---|---|
String |
|
getPostProcessors
public List<IPostProcessor> getPostProcessors ()
从配置中获取 IPostProcessor。
| 返回 | |
|---|---|
List<IPostProcessor> |
|
getRetryDecision
public IRetryDecision getRetryDecision ()
返回用于调用的 IRetryDecision。
| 返回 | |
|---|---|
IRetryDecision |
|
getSystemStatusCheckers
public List<ISystemStatusChecker> getSystemStatusCheckers ()
从配置中获取 ISystemStatusChecker。
| 返回 | |
|---|---|
List<ISystemStatusChecker> |
按顺序在配置中提供的 ISystemStatusChecker |
getTargetPreparers
public List<ITargetPreparer> getTargetPreparers ()
从配置中获取 ITargetPreparer。
| 返回 | |
|---|---|
List<ITargetPreparer> |
按顺序在配置中提供的 ITargetPreparer |
getTestInvocationListeners
public List<ITestInvocationListener> getTestInvocationListeners ()
从配置中获取要使用的 ITestInvocationListener。
| 返回 | |
|---|---|
List<ITestInvocationListener> |
配置中提供的 ITestInvocationListener。 |
injectOptionValue
public void injectOptionValue (String optionName,
String optionValue)将选项值注入到配置对象集中。
有助于为动态生成的选项提供值。
| 参数 | |
|---|---|
optionName |
String:选项名称 |
optionValue |
String:选项值 |
| 抛出 | |
|---|---|
ConfigurationException |
|
injectOptionValue
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 (List<OptionDef> optionDefs)
将多个选项值注入到配置对象集中。
在创建新对象后,可用于一次性注入多个选项值。
| 参数 | |
|---|---|
optionDefs |
List:要注入的选项定义列表 |
| 抛出 | |
|---|---|
ConfigurationException |
|
isDeviceConfiguredFake
public boolean isDeviceConfiguredFake (String deviceName)
返回配置的设备是否标记为 isFake=true。
| 参数 | |
|---|---|
deviceName |
String |
| 返回 | |
|---|---|
boolean |
|
partialDeepClone
public IConfiguration partialDeepClone (List<String> objectToDeepClone, IKeyStoreClient client)
从 clone() 创建一个基本克隆,然后对给定的配置对象列表进行深度克隆。
| 参数 | |
|---|---|
objectToDeepClone |
List:要深度克隆的配置对象的列表。 |
client |
IKeyStoreClient:密钥库客户端。 |
| 返回 | |
|---|---|
IConfiguration |
部分深层克隆的配置。 |
| 抛出 | |
|---|---|
ConfigurationException |
|
printCommandUsage
public void printCommandUsage (boolean importantOnly,
PrintStream out)将相应配置的命令行使用帮助文本输出到给定的 printStream。
| 参数 | |
|---|---|
importantOnly |
boolean:如果为 true,则仅打印重要选项的帮助信息 |
out |
PrintStream:要使用的 PrintStream。 |
| 抛出 | |
|---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
|
resolveDynamicOptions
public void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
解析指向远程位置的 File 的解析选项。这需要调用 cleanConfigurationData() 来清理文件。
| 参数 | |
|---|---|
resolver |
DynamicRemoteFileResolver:用于解析文件的 DynamicRemoteFileResolver |
| 抛出 | |
|---|---|
BuildRetrievalError |
|
ConfigurationException |
|
safeInjectOptionValues
public void safeInjectOptionValues (List<OptionDef> optionDefs)
将多个选项值注入到配置对象集中,如果其中一个选项无法应用,也不会抛出异常。
在创建新对象后,可用于一次性注入多个选项值。
| 参数 | |
|---|---|
optionDefs |
List:要注入的选项定义列表 |
| 抛出 | |
|---|---|
ConfigurationException |
|
setBestEffortOptionsFromCommandLineArgs
public List<String> setBestEffortOptionsFromCommandLineArgs (List<String> listArgs,
IKeyStoreClient keyStoreClient)使用尽力而为的方法,通过给定的命令行实参集设置配置 Option 字段。
如需了解预期格式,请参阅 ArgsOptionParser
| 参数 | |
|---|---|
listArgs |
List:命令行实参 |
keyStoreClient |
IKeyStoreClient:要使用的 IKeyStoreClient。 |
| 返回 | |
|---|---|
List<String> |
未使用的实参 |
| 抛出 | |
|---|---|
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,
List<?> configList)用于设置指定名称的配置对象列表(替换任何现有值)的通用方法。
| 参数 | |
|---|---|
typeName |
String:配置对象类型的唯一名称。 |
configList |
List:配置对象列表 |
| 抛出 | |
|---|---|
ConfigurationException |
|
setCoverageOptions
public void setCoverageOptions (CoverageOptions coverageOptions)
设置 CoverageOptions,替换所有现有值。
| 参数 | |
|---|---|
coverageOptions |
CoverageOptions |
setDeviceConfig
public void setDeviceConfig (IDeviceConfiguration deviceConfig)
设置 IDeviceConfiguration,替换所有现有值。
setDeviceConfigList
public void setDeviceConfigList (List<IDeviceConfiguration> deviceConfigs)
设置 IDeviceConfiguration,替换所有现有值。
setDeviceMetricCollectors
public void setDeviceMetricCollectors (List<IMetricCollector> collectors)
设置 IMetricCollector 的列表,替换所有现有值。
| 参数 | |
|---|---|
collectors |
List |
setDeviceOptions
public void setDeviceOptions (TestDeviceOptions devOptions)
设置 TestDeviceOptions,替换所有现有值
| 参数 | |
|---|---|
devOptions |
TestDeviceOptions |
setDeviceRecovery
public void setDeviceRecovery (IDeviceRecovery recovery)
设置 IDeviceRecovery,替换所有现有值。
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
设置 IDeviceSelection,替换所有现有值
setLabPreparers
public void setLabPreparers (List<ITargetPreparer> preparers)
设置 ITargetPreparer 的列表,替换所有现有值。
setMultiPreTargetPreparer
public void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPrep)
一种便捷方法,用于在此配置中设置单个 IMultiTargetPreparer,该 IMultiTargetPreparer 应在任何设备 target_preparer 之前执行,并替换任何现有值
setMultiPreTargetPreparers
public void setMultiPreTargetPreparers (List<IMultiTargetPreparer> multiPreTargPreps)
设置此配置中应在任何设备 target_preparer 之前执行的 IMultiTargetPreparer 列表,替换任何现有值
setMultiTargetPreparer
public void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)
用于在此配置中设置单个 IMultiTargetPreparer 的便捷方法,会替换任何现有值
setMultiTargetPreparers
public void setMultiTargetPreparers (List<IMultiTargetPreparer> multiTargPreps)
在此配置中设置 IMultiTargetPreparer 的列表,替换所有现有值
setOptionsFromCommandLineArgs
public List<String> setOptionsFromCommandLineArgs (List<String> listArgs)
使用给定的命令行实参集设置配置 Option 字段
ArgsOptionParser,了解预期格式
| 参数 | |
|---|---|
listArgs |
List:命令行实参 |
| 返回 | |
|---|---|
List<String> |
未使用的实参 |
| 抛出 | |
|---|---|
ConfigurationException |
|
setOptionsFromCommandLineArgs
public List<String> setOptionsFromCommandLineArgs (List<String> listArgs,
IKeyStoreClient keyStoreClient)使用给定的命令行实参集设置配置 Option 字段
如需了解预期格式,请参阅 ArgsOptionParser
| 参数 | |
|---|---|
listArgs |
List:命令行实参 |
keyStoreClient |
IKeyStoreClient:要使用的 IKeyStoreClient。 |
| 返回 | |
|---|---|
List<String> |
未使用的实参 |
| 抛出 | |
|---|---|
ConfigurationException |
|
setPostProcessors
public void setPostProcessors (List<IPostProcessor> processors)
设置 IPostProcessor 的列表,替换所有现有值。
| 参数 | |
|---|---|
processors |
List |
setRetryDecision
public void setRetryDecision (IRetryDecision decisionRetry)
设置 IRetryDecision,替换所有现有值。
setSkipManager
public void setSkipManager (SkipManager skipManager)
为调用设置 SkipManager。
| 参数 | |
|---|---|
skipManager |
SkipManager |
setSystemStatusChecker
public void setSystemStatusChecker (ISystemStatusChecker systemChecker)
用于在此配置中设置单个 ISystemStatusChecker 的便捷方法,会替换任何现有值
setSystemStatusCheckers
public void setSystemStatusCheckers (List<ISystemStatusChecker> systemCheckers)
在此配置中设置 ISystemStatusChecker 的列表,替换所有现有值
setTargetPreparer
public void setTargetPreparer (ITargetPreparer preparer)
设置 ITargetPreparer,替换所有现有值。
setTargetPreparers
public void setTargetPreparers (List<ITargetPreparer> preparers)
设置 ITargetPreparer 的列表,替换所有现有值。
setTestInvocationListener
public void setTestInvocationListener (ITestInvocationListener listener)
用于设置单个 ITestInvocationListener 的便捷方法
setTestInvocationListeners
public void setTestInvocationListeners (List<ITestInvocationListener> listeners)
设置 ITestInvocationListener 的列表,替换所有现有值
validateOptions
public void validateOptions ()
验证选项值。
目前,这只会验证是否已设置所有必需的选项
| 抛出 | |
|---|---|
ConfigurationException |
|
受保护的方法
isRemoteEnvironment
protected boolean isRemoteEnvironment ()
返回 TF 的环境是否为远程调用。
| 返回 | |
|---|---|
boolean |
|