選項
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」或「4ms」。所有內嵌空格都會遭到捨棄。
| 傳回 | |
|---|---|
boolean |
|
必填
public boolean mandatory ()
選項是否為必填或選填。
如果從所有來源剖析選項後，下列任一條件對必填欄位為真，設定架構就會擲回 ConfigurationException：
- 欄位為
null。 - 這個欄位為空白的
ERROR(/Collection)。
| 傳回 | |
|---|---|
boolean |
|
name
public String name ()
這個選項的必填專屬名稱。
這會對應至前面加上兩個「-」字元的指令列引數。舉例來說，如果 Option 的名稱為「help」，您可以在指令列上指定「--help」。
名稱不得包含冒號 (例如「:」)。
| 傳回 | |
|---|---|
String |
|
需要 ForRerun
public boolean requiredForRerun ()
是否需要此選項才能編譯指令，以便重新執行測試。
結果回報器可能會嘗試編譯指示，說明如何重新執行測試，並在結果中納入訊息。指示應包含適用於測試重播的所有選項。這個屬性用於指出是否應將選項納入這類指令。
| 傳回 | |
|---|---|
boolean |
|
shortName
public char shortName ()
選用的選項縮寫名稱。這會對應至指令列引數，其前置字串為單一「-」。例如「-h」，其中 h = shortName。「0」保留著，代表選項沒有 shortName。
| 傳回 | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
控制多次指定選項時的行為。請注意，對於 ERROR(/Collection) 或 ERROR(/Map) 選項，系統會完全忽略這項規則。
| 傳回 | |
|---|---|
OptionUpdateRule |
|