选项
public abstract @interface Option
implements Annotation
com.android.tradefed.config.Option |
将字段注释为代表IConfiguration
选项的字段。
概要
嵌套类 | |
---|---|
enum | Option.Importance
|
常数 | |
---|---|
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 |
简称
public char shortName ()
可选的缩写名称。这将映射到以单个“-”为前缀的命令行参数。例如“ -h”,其中h = shortName。保留'0'表示该选项没有shortName。
退货 | |
---|---|
char |
updateRule
public OptionUpdateRule updateRule ()
控制多次指定选项时的行为。请注意,对于ERROR(/Collection)
或ERROR(/Map)
的选项,此规则将完全忽略。
退货 | |
---|---|
OptionUpdateRule |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2019-10-02 UTC.