オプション
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)
パブリック メソッド
description
public String description ()
オプションのわかりやすい説明。
| 戻り値 | |
|---|---|
String |
|
重要度
public Option.Importance importance ()
オプションの重要性。
「重要」と見なされるオプションは、省略されたヘルプ出力に表示されます。重要でないオプションのヘルプは、完全なヘルプテキストにのみ表示されます。
| 戻り値 | |
|---|---|
Option.Importance |
|
isTimeVal
public boolean isTimeVal ()
オプションが時間値を表すかどうか。
時刻値の場合は、時刻固有の接尾辞が解析されます。このフラグが有効になるには、フィールドが long または Long である必要があります。ConfigurationException がスローされます。
デフォルトの単位はミリ秒です。構成フレームワークでは、秒（1,000 ミリ秒）の場合は s、分（60 秒）の場合は m、時間（60 分）の場合は h、日（24 時間）の場合は d を使用できます。
各ユニットが最大 1 回表示され、表示されるすべてのユニットがスケールの降順で並べられている限り、ユニットを組み合わせて使用できます。たとえば、h は m の前にのみ、または d の後にのみ表示できます。具体的な例として、「1d2h3m4s5ms」は有効な時間値です。また、「4」や「4ms」も有効です。埋め込まれた空白はすべて破棄されます。
| 戻り値 | |
|---|---|
boolean |
|
必須
public boolean mandatory ()
オプションが必須か省略可能か。
すべてのソースからオプションが解析された後、必須フィールドで次のいずれかに該当する場合、構成フレームワークは ConfigurationException をスローします。
- フィールドは
nullです。 - フィールドは空の
ERROR(/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 ()
オプションが複数回指定された場合の動作を制御します。なお、このルールは、ERROR(/Collection) または ERROR(/Map) であるオプションでは完全に無視されます。
| 戻り値 | |
|---|---|
OptionUpdateRule |
|