選項
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 |
isTimeVal
public boolean isTimeVal ()
選項是否代表時間值。
如果這是時間值,系統會剖析特定時間後置字串。欄位
long
或 Long
,這個旗標才有效。否則會擲回 ConfigurationException
。
預設單位為毫秒。設定架構將接受 s
的秒數
(1000 毫秒)、m
代表分鐘 (60 秒)、h
代表小時 (60 分鐘),或
d
代表天 (24 小時)。
單位可以混合並比對,只要每個單位最多出現一次,
出現的所有單位都是按比例遞減排序。舉例來說,h
只能顯示在 m
之前,且可能只有在 d
之後才會顯示。明確
例如「1d2h3m4s5ms」就是有效的時間值,就像「4」一樣或「4 毫秒」所有嵌入項目
空白字元。
傳回 | |
---|---|
boolean |
必填
public boolean mandatory ()
選項為必填或選填。
如果以下任一情況發生,設定架構就會擲回 ConfigurationException
從所有來源剖析選項後,將具有以下特性:
- 欄位為
null
。 - 這個欄位為空白的
ERROR(/Collection)
。
傳回 | |
---|---|
boolean |
name
public String name ()
這個選項的必要名稱不重複。
這會對應至前置字串為兩個「-」的指令列引數字元。
例如名稱為「help」的 Option
可以透過「--help」指定的
指令列
名稱不得包含冒號 (例如「:」)。
傳回 | |
---|---|
String |
需要 ForRerun
public boolean requiredForRerun ()
是否需要此選項編譯指令以重新執行測試。
結果回報器可能會試著編譯指示,說明如何重新執行測試,並加入 訊息。指示應包含適用於測試的所有選項 能重新執行這個屬性可用來指出是否應將選項包含 指示
傳回 | |
---|---|
boolean |
簡稱
public char shortName ()
選填的選項縮寫名稱。 這會對應至前置字串為「-」的指令列引數。 例如:「-h」其中 h = shortName。 「0」為保留狀態,表示選項沒有 shortName。
傳回 | |
---|---|
char |
updateRule (更新規則)
public OptionUpdateRule updateRule ()
控管指定選項多次時的行為。請注意,這項規則是
完全忽略 ERROR(/Collection)
或 ERROR(/Map)
選項。
傳回 | |
---|---|
OptionUpdateRule |