选项
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 |
时间值
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 = 短名称。保留“0”表示该选项没有短名称。
退货 | |
---|---|
char |
更新规则
public OptionUpdateRule updateRule ()
控制多次指定选项时的行为。请注意,对于ERROR(/Collection)
或ERROR(/Map)
选项,此规则将被完全忽略。
退货 | |
---|---|
OptionUpdateRule |