选项
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。 - 该字段为空
Collection。
| 返回 | |
|---|---|
boolean |
|
名称
public String name ()
该选项的必填唯一名称。
这将映射到以两个“-”字符为前缀的命令行实参。
例如，名称为“help”的 Option 将在
命令行中指定为“--help”。
名称不得包含英文冒号 (:)。
| 返回 | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
是否需要该选项来编译指令以重新运行测试。
结果报告器可能会尝试编译有关如何重新运行测试的指令，并将该 消息包含在结果中。该指令应包含适用于测试 重新运行的所有选项。此属性用于指明是否应将该选项包含在此类 指令中。
| 返回 | |
|---|---|
boolean |
|
shortName
public char shortName ()
该选项的可选缩写名称。 这将映射到以单个“-”为前缀的命令行实参。 例如，“-h”，其中 h = shortName。 “0”保留用于表示该选项没有 shortName。
| 返回 | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
控制多次指定选项时的行为。 请注意，对于 Collection 或 Map 类型的选项，此规则将被
完全忽略。
| 返回 | |
|---|---|
OptionUpdateRule |
|