選項
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 |