オプション
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 がスローされます。
デフォルトの単位は millis です。構成フレームワークでは、秒（1,000 ミリ秒）の場合は s、分（60 秒）の場合は m、時間（60 分）の場合は h、日（24 時間）の場合は d が受け入れられます。
単位は混在させることができます。ただし、各単位は最大 1 回までしか使用できず、使用するすべての単位はスケールの降順でリストする必要があります。たとえば、h は m の前にのみ表示され、d の後にのみ表示されることがあります。たとえば、「1d2h3m4s5ms」は有効な時間値です。「4」や「4ms」も有効です。埋め込まれた空白はすべて破棄されます。
| 戻り値 | |
|---|---|
boolean |
|
必須
public boolean mandatory ()
オプションが必須か省略可能か。
すべてのソースからオプションが解析された後、必須フィールドについて次のいずれかの条件が満たされると、構成フレームワークは ConfigurationException をスローします。
- フィールドは
nullです。 - フィールドが空の
Collectionである。
| 戻り値 | |
|---|---|
boolean |
|
name
public String name ()
このオプションの必須の一意の名前。
これは、2 つの「-」文字で始まるコマンドライン引数にマッピングされます。たとえば、名前が「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 |
|