ConfigurationDescriptor
public
class
ConfigurationDescriptor
extends Object
java.lang.Object | |
↳ | com.android.tradefed.config.ConfigurationDescriptor |
用于描述配置本身某些方面的配置对象。例如会员测试套件标记。此类无法通过命令行接收选项值。只能直接在 XML 中。
摘要
字段 | |
---|---|
public
static
final
String |
ACTIVE_PARAMETER_KEY
配置参数化的元数据键,可选。 |
public
static
final
String |
LOCAL_SHARDED_KEY
配置的元数据键,用于指定其已分片。 |
public
static
final
String |
MODULE_DIR_PATH_KEY
配置的元数据键,用于在配置为模块配置时指定模块目录路径。 |
public
static
final
String |
PRIORITIZE_HOST_CONFIG_KEY
配置的元数据键,用于指定其是否优先使用主机配置。 |
公共构造函数 | |
---|---|
ConfigurationDescriptor()
|
公共方法 | |
---|---|
void
|
addMetadata(String key,
向元数据条目添加给定键的更多值。 |
void
|
addRerunOption(OptionDef optionDef)
将该选项添加到可用于重新运行测试的选项列表中。 |
ConfigurationDescriptor
|
clone()
返回 |
static
ConfigurationDescriptor
|
fromProto(ConfigurationDescription.Descriptor protoDescriptor)
从 |
IAbi
|
getAbi()
返回配置所依赖的 ABI(如果已知),否则返回 null。 |
MultiMap<String, String>
|
getAllMetaData()
检索所有已配置的元数据,并返回映射的副本。 |
|
getMetaData(String name)
获取命名元数据条目 |
String
|
getModuleName()
返回模块配置的模块名称。 |
|
getRerunOptions()
获取可用于重新运行的 |
Integer
|
getShardIndex()
在本地分片期间获取调用的分片编号。 |
|
getSuiteTags()
返回测试所属的套件标记列表。 |
boolean
|
isNotIRemoteTestShardable()
返回配置是否应将 IRemoteTest 拆分为不同的模块。 |
boolean
|
isNotShardable()
返回配置是否可作为套件的一部分进行分片 |
boolean
|
isNotStrictShardable()
返回配置是否为套件的一部分且是否可严格分片 |
|
removeMetadata(String key)
移除指定元数据键的跟踪。 |
void
|
setAbi(IAbi abi)
设置配置将在哪个 ABI 下运行。 |
void
|
setMetaData(MultiMap<String, String> metadata)
|
void
|
setModuleName(String name)
如果此配置代表模块,我们可以设置与其关联的模块名称。 |
void
|
setNotIRemoteTestShardable(boolean notIRemoteTestShardable)
|
void
|
setSandboxed(boolean useSandboxed)
设置配置是否将在沙盒模式下运行。 |
void
|
setShardIndex(int index)
在本地分片中为调用设置分片编号。 |
void
|
setSuiteTags(
设置测试所属的套件标记列表。 |
boolean
|
shouldUseSandbox()
如果调用应在沙盒模式下运行,则返回 true。 |
ConfigurationDescription.Descriptor
|
toProto()
将描述符的当前实例转换为其 proto 格式。 |
字段
ACTIVE_PARAMETER_KEY
public static final String ACTIVE_PARAMETER_KEY
配置参数化的元数据键,可选。
LOCAL_SHARDED_KEY
public static final String LOCAL_SHARDED_KEY
配置的元数据键,用于指定其已分片。
MODULE_DIR_PATH_KEY
public static final String MODULE_DIR_PATH_KEY
配置的元数据键,用于在配置为模块配置时指定模块目录路径。
PRIORITIZE_HOST_CONFIG_KEY
public static final String PRIORITIZE_HOST_CONFIG_KEY
配置的元数据键,用于指定其是否优先使用主机配置。
公共构造函数
ConfigurationDescriptor
public ConfigurationDescriptor ()
公共方法
addMetadata
public void addMetadata (String key,values)
向元数据条目添加给定键的更多值。
参数 | |
---|---|
key |
String :要向其添加值的键的 String 。 |
values |
:其他值的 String 列表。 |
addRerunOption
public void addRerunOption (OptionDef optionDef)
将该选项添加到可用于重新运行测试的选项列表中。
参数 | |
---|---|
optionDef |
OptionDef :测试选项的 OptionDef 对象。 |
clone
public ConfigurationDescriptor clone ()
返回 ConfigurationDescriptor
对象的深层副本。
返回 | |
---|---|
ConfigurationDescriptor |
fromProto
public static ConfigurationDescriptor fromProto (ConfigurationDescription.Descriptor protoDescriptor)
从 toProto()
执行反向操作以取回对象。
参数 | |
---|---|
protoDescriptor |
ConfigurationDescription.Descriptor |
返回 | |
---|---|
ConfigurationDescriptor |
getAllMetaData
public MultiMap<String, String> getAllMetaData ()
检索所有已配置的元数据,并返回映射的副本。
返回 | |
---|---|
MultiMap<String, String> |
getMetaData
publicgetMetaData (String name)
获取命名元数据条目
参数 | |
---|---|
name |
String |
返回 | |
---|---|
|
getModuleName
public String getModuleName ()
返回模块配置的模块名称。
返回 | |
---|---|
String |
getShardIndex
public Integer getShardIndex ()
在本地分片期间获取调用的分片编号。如果没有分片,则返回 null。
返回 | |
---|---|
Integer |
getSuiteTags
publicgetSuiteTags ()
返回测试所属的套件标记列表。
返回 | |
---|---|
|
isNotIRemoteTestShardable
public boolean isNotIRemoteTestShardable ()
返回配置是否应将 IRemoteTest 拆分为不同的模块。
返回 | |
---|---|
boolean |
isNotShardable
public boolean isNotShardable ()
返回配置是否可作为套件的一部分进行分片
返回 | |
---|---|
boolean |
isNotStrictShardable
public boolean isNotStrictShardable ()
返回配置是否为套件的一部分且是否可严格分片
返回 | |
---|---|
boolean |
removeMetadata
publicremoveMetadata (String key)
移除指定元数据键的跟踪。
参数 | |
---|---|
key |
String |
返回 | |
---|---|
|
setModuleName
public void setModuleName (String name)
如果此配置代表模块,我们可以设置与其关联的模块名称。
参数 | |
---|---|
name |
String |
setNotIRemoteTestShardable
public void setNotIRemoteTestShardable (boolean notIRemoteTestShardable)
参数 | |
---|---|
notIRemoteTestShardable |
boolean |
setSandboxed
public void setSandboxed (boolean useSandboxed)
设置配置是否将在沙盒模式下运行。
参数 | |
---|---|
useSandboxed |
boolean |
setShardIndex
public void setShardIndex (int index)
在本地分片中为调用设置分片编号。
参数 | |
---|---|
index |
int |
setSuiteTags
public void setSuiteTags (suiteTags)
设置测试所属的套件标记列表。
参数 | |
---|---|
suiteTags |
|
shouldUseSandbox
public boolean shouldUseSandbox ()
如果调用应在沙盒模式下运行,则返回 true。否则为 false。
返回 | |
---|---|
boolean |
toProto
public ConfigurationDescription.Descriptor toProto ()
将描述符的当前实例转换为其 proto 格式。
返回 | |
---|---|
ConfigurationDescription.Descriptor |