オプション

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がスローされます。

デフォルトの単位はミリ秒です。構成フレームワークは、秒 (1000 ミリ秒) を表すs 、分 (60 秒) を表すh 、時間 (60 分) をm h、または日 (24 時間) を表すdを受け入れます。

ユニットは、各ユニットが最大 1 回出現する限り、また出現するすべてのユニットがスケールの降順でリストされている限り、混合して一致させることができます。したがって、たとえば、 h m前にのみ表示され、 d後にのみ表示される場合があります。具体的な例として、「1d2h3m4s5ms」は「4」または「4ms」と同様に有効な時間値です。埋め込まれた空白はすべて破棄されます。

戻り値
boolean

必須

public boolean mandatory ()

オプションが必須かオプションか。

オプションがすべてのソースから解析された後、必須フィールドが次のいずれかに該当する場合、構成フレームワークはConfigurationExceptionをスローします。

戻り値
boolean

名前

public String name ()

このオプションの必須の一意の名前。

これは、2 つの「-」文字で始まるコマンド ライン引数にマップされます。たとえば、「help」という名前のOptionコマンド ラインで「--help」を指定して指定します。

名前に「:」などのコロンを含めることはできません。

戻り値
String

必須の再実行

public boolean requiredForRerun ()

テストを再実行する命令をコンパイルするためにオプションが必要かどうか。

結果レポーターは、テストを再実行する方法に関する指示をコンパイルして、結果にメッセージを含めようとする場合があります。指示には、テストの再実行に適用されるすべてのオプションを含める必要があります。この属性は、オプションがそのような命令に含まれるかどうかを示すために使用されます。

戻り値
boolean

短い名前

public char shortName ()

オプションの略称。これは、単一の「-」で始まるコマンド ライン引数にマップされます。例: "-h" (h = shortName)。 '0' は、オプションに shortName がないことを意味するために予約されています。

戻り値
char

updateRule

public OptionUpdateRule updateRule ()

オプションが複数回指定された場合の動作を制御します。 ERROR(/Collection)またはERROR(/Map)であるオプションでは、この規則は完全に無視されることに注意してください。

戻り値
OptionUpdateRule