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

用于指定配置已被分片的元数据键。

公共构造函数

ConfigurationDescriptor()

公共方法

void addMetadata(String key, values)

向元数据条目添加更多给定键的值。

void addMetadata(String key, String value)

将给定键的值添加到元数据条目中。

void addRerunOption(OptionDef optionDef)

将该选项添加到可用于重新运行测试的选项列表中。

ConfigurationDescriptor clone()

返回 ConfigurationDescriptor 对象的深层副本。

static ConfigurationDescriptor fromProto(ConfigurationDescription.Descriptor protoDescriptor)

toProto() 执行逆向运算,以返回对象。

IAbi getAbi()

如果已知,则返回配置所针对的 ABI,否则返回 null。

MultiMap<String, String> getAllMetaData()

检索所有已配置的元数据并返回地图的副本。

getMetaData(String name)

获取指定的元数据条目

String getModuleName()

返回模块配置的模块名称。

getRerunOptions()

获取可用于重新运行的 OptionDef 列表。

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( suiteTags)

设置测试所属的套件标记的列表。

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

用于指定配置已被分片的元数据键。

公共构造函数

ConfigurationDescriptor(配置描述符)

public ConfigurationDescriptor ()

公共方法

添加元数据

public void addMetadata (String key, 
                 values)

向元数据条目添加更多给定键的值。

参数
key String:要向其中添加值的键的 String

values :其他值 String 的列表。

添加元数据

public void addMetadata (String key, 
                String value)

将给定键的值添加到元数据条目中。

参数
key String:要向其中添加值的键的 String

value String:附加值的 String

addRerunOption

public void addRerunOption (OptionDef optionDef)

将该选项添加到可用于重新运行测试的选项列表中。

参数
optionDef OptionDef:测试选项的 OptionDef 对象。

克隆

public ConfigurationDescriptor clone ()

返回 ConfigurationDescriptor 对象的深层副本。

返回
ConfigurationDescriptor

来自 Proto

public static ConfigurationDescriptor fromProto (ConfigurationDescription.Descriptor protoDescriptor)

toProto() 执行逆向运算,以返回对象。

参数
protoDescriptor ConfigurationDescription.Descriptor

返回
ConfigurationDescriptor

getAbi

public IAbi getAbi ()

如果已知,则返回配置所针对的 ABI,否则返回 null。

返回
IAbi

getAllMetaData

public MultiMap<String, String> getAllMetaData ()

检索所有已配置的元数据并返回地图的副本。

返回
MultiMap<String, String>

获取元数据

public  getMetaData (String name)

获取指定的元数据条目

参数
name String

返回

getModuleName

public String getModuleName ()

返回模块配置的模块名称。

返回
String

getRerunOptions

public  getRerunOptions ()

获取可用于重新运行的 OptionDef 列表。

返回

getShardIndex

public Integer getShardIndex ()

获取本地分片期间调用的分片索引。如果未分片,则返回 null。

返回
Integer

getSuiteTag

public  getSuiteTags ()

返回测试所属的套件标记的列表。

返回

isNotIRemoteTestShardable(可分片)

public boolean isNotIRemoteTestShardable ()

返回配置是否应将 IRemoteTest 拆分为不同模块。

返回
boolean

isNotShardable(不可分片)

public boolean isNotShardable ()

返回配置是否可分片或不是套件的一部分的返回值

返回
boolean

isNotStrictShardable(非严格可分片)

public boolean isNotStrictShardable ()

返回配置是否严格可分片或不是套件的一部分的返回值

返回
boolean

移除元数据

public  removeMetadata (String key)

移除对指定元数据键的跟踪。

参数
key String

返回

SetAbi

public void setAbi (IAbi abi)

设置将针对哪个 ABI 运行配置。

参数
abi IAbi

setMetaData

public void setMetaData (MultiMap<String, String> metadata)

参数
metadata MultiMap

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

setSuiteTag

public void setSuiteTags ( suiteTags)

设置测试所属的套件标记的列表。

参数
suiteTags

应当使用沙盒

public boolean shouldUseSandbox ()

如果调用应在沙盒模式下运行,则返回 true。否则为 false。

返回
boolean

ToProto

public ConfigurationDescription.Descriptor toProto ()

将描述符的当前实例转换为其 proto 格式。

返回
ConfigurationDescription.Descriptor