オプション

public abstract @interface Option
implements Annotation

com.android.tradefed.config.オプション


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 秒) を表すm 、時間 (60 分) を表す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

更新ルール

public OptionUpdateRule updateRule ()

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

戻り値
OptionUpdateRule