选项

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


将字段注释为表示 IConfiguration 选项。

摘要

常量

char NO_SHORT_NAME

公共方法

String description()

简单易懂的选项说明。

Option.Importance importance()

选项的重要性。

boolean isTimeVal()

选项是否表示时间值。

boolean mandatory()

选项是强制选项还是可选选项。

String name()

此选项的必填唯一名称。

boolean requiredForRerun()

是否需要该选项来编译指令以重新运行测试。

char shortName()

(可选)选项的缩写名称。

OptionUpdateRule updateRule()

控制多次指定某个选项时的行为。

常量

NO_SHORT_NAME

public static final char NO_SHORT_NAME

常量值: 48 (0x00000030)

公共方法

说明

public String description ()

简单易懂的选项说明。

返回
String

重要程度

public Option.Importance importance ()

选项的重要性。

选项被视为“重要”则会显示在简写帮助输出内容中。帮助 “不重要”选项只会显示在完整的帮助文本中。

返回
Option.Importance

isTimeVal

public boolean isTimeVal ()

选项是否表示时间值。

如果这是一个时间值,系统会解析特定于时间的后缀。字段 必须longLong,此标志才有效。否则,将抛出 ConfigurationException

默认单位为毫秒。配置框架将接受 s(以秒为单位) (1000 毫秒)、m 表示分钟(60 秒)、h 表示小时(60 分钟),或者 d 表示天(24 小时)。

广告单元可以混搭,但前提是每个广告单元最多出现一次, 所有显示的单位按范围降序排列。例如,h 可能只出现在 m 之前,也可能只出现在 d 之后。作为 示例:“1d2h3m4s5ms”是有效的时间值,如“4”或“4ms”。所有嵌入式 空白。

返回
boolean

必填

public boolean mandatory ()

选项是强制选项还是可选选项。

如果存在以下任一情况,配置框架将抛出 ConfigurationException 从所有来源解析完选项后,将出现以下必填字段:

返回
boolean

name

public String name ()

此选项的必填唯一名称。

这将映射到前缀为两个“-”的命令行参数字符。 例如,名为“help”的 Option将用“--help”指定在 命令行。

名称不得包含冒号,例如“:”。

返回
String

requiredForRerun

public boolean requiredForRerun ()

是否需要该选项来编译指令以重新运行测试。

结果报告程序可能会尝试编译有关如何重新运行测试的指令,并在其中包含 消息。该说明应包含适用于测试的所有选项 重新运行。该属性用于指明相应选项是否应包括在此类 指令。

返回
boolean

简称

public char shortName ()

(可选)选项的缩写名称。 这将映射到以单个“-”为前缀的命令行参数。 例如“-h”其中 h = 简称。 “0”表示该选项没有简称。

返回
char

updateRule

public OptionUpdateRule updateRule ()

控制多次指定某个选项时的行为。请注意,此规则 对于 ERROR(/Collection)ERROR(/Map) 选项,系统会完全忽略这些选项。

返回
OptionUpdateRule