选项
public abstract @interface Option
implements Annotation
com.android.tradefed.config.选项 |
将字段注释为表示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 |
时间值
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”的Option
将在命令行中使用“--help”指定。名称不能包含冒号,例如“:”。退货 | |
---|---|
String |
需要重新运行
public boolean requiredForRerun ()
是否需要该选项来编译指令以重新运行测试。
结果报告者可能会尝试编译有关如何重新运行测试的说明,并将消息包含在结果中。该说明应包括适用于重新运行测试的所有选项。该属性用于指示该选项是否应包含在此类指令中。
退货 | |
---|---|
boolean |
简称
public char shortName ()
选项的可选缩写名称。这将映射到以单个“-”为前缀的命令行参数。例如“-h”,其中 h = shortName。 '0' 保留表示该选项没有短名称。
退货 | |
---|---|
char |
更新规则
public OptionUpdateRule updateRule ()
控制多次指定选项时的行为。请注意,对于ERROR(/Collection)
s 或ERROR(/Map)
s 的选项,此规则将被完全忽略。
退货 | |
---|---|
OptionUpdateRule |