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