選項
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()
Controls the behavior when an option is specified multiple times. |
常數
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。 - 欄位為空白
Collection。
| 傳回 | |
|---|---|
boolean |
|
名稱
public String name ()
這個選項的必要專屬名稱。
這會對應至以兩個「-」字元為前置字元的指令列引數。
舉例來說,名稱為「help」的 Option 會在指令列上以「--help」指定。
名稱不得包含半形冒號 (例如「:」)。
| 傳回 | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
是否需要這個選項來編譯指令,以重新執行測試。
結果回報器可能會嘗試編譯如何重新執行測試的指令,並將訊息納入結果。指示應包含適用於測試重新執行的所有選項。這項屬性用於指出選項是否應納入這類指示。
| 傳回 | |
|---|---|
boolean |
|
shortName
public char shortName ()
選項的選用縮寫名稱。 這會對應至以單一「-」為前置字元的指令列引數。 例如「-h」,其中 h = shortName。 「0」保留做為選項沒有 shortName 的意思。
| 傳回 | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
控制多次指定選項時的行為。請注意,如果選項是 Collection 或 Map,系統會完全忽略這項規則。
| 傳回 | |
|---|---|
OptionUpdateRule |
|