选项
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 ()
该选项是否表示时间值。
如果这是时间值，系统会解析特定于时间的后缀。该字段long 或 Long，此标志才有效。否则，系统会抛出 ConfigurationException。
默认单位为毫秒。配置框架接受 s（秒 [1000 毫秒]）、m（分钟 [60 秒]）、h（小时 [60 分钟]）或 d（天 [24 小时]）的值。
您可以混合使用各种单位，但每个单位最多只能出现一次，并且所有显示的单位都应按缩放比例从大到小排列。例如，h 只能出现在 m 之前，并且只能出现在 d 之后。具体而言，“1d2h3m4s5ms”是一个有效的时间值，而“4”或“4ms”也是。所有嵌入的空格都会被舍弃。
| 返回 | |
|---|---|
boolean |
|
必填
public boolean mandatory ()
选项是必需的还是可选的。
如果在从所有来源解析选项后，必填字段满足以下任一条件，配置框架将抛出 ConfigurationException：
- 该字段为
null。 - 该字段为空
ERROR(/Collection)。
| 返回 | |
|---|---|
boolean |
|
名称
public String name ()
此选项的强制性唯一名称。
这将映射到以两个“-”字符开头的命令行参数。例如，在命令行中，您可以使用“--help”指定名为“help”的 Option。
名称不得包含英文冒号，例如“:”。
| 返回 | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
是否需要该选项来编译重新运行测试的说明。
结果报告程序可能会尝试编译有关如何重新运行测试的说明，并在结果中包含该消息。该说明应包含适用于测试重跑的所有选项。此属性用于指明是否应将该选项包含在此类指令中。
| 返回 | |
|---|---|
boolean |
|
shortName
public char shortName ()
选项的可选缩写名称。 这将映射到带有单个“-”前缀的命令行参数。例如“-h”，其中 h = shortName。 “0”表示选项没有 shortName。
| 返回 | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
控制多次指定选项时的行为。请注意，对于 ERROR(/Collection) 或 ERROR(/Map) 选项，系统会完全忽略此规则。
| 返回 | |
|---|---|
OptionUpdateRule |
|