オプション

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

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

各ユニットを 1 回だけ表示し、 表示されるすべてのユニットは、スケールの大きい順にリストされます。そのため、たとえば hm の前と 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

略称

public char shortName ()

オプションの略称(省略可)。 これは、1 つの「-」で始まるコマンドライン引数にマッピングされます。 例:「-h」ここで、h は shortName です。 「0」オプションに shortName がないことを意味します。

戻り値
char

updateRule

public OptionUpdateRule updateRule ()

オプションが複数回指定された場合の動作を制御します。なお、このルールは ERROR(/Collection) または ERROR(/Map) のオプションに対しては完全に無視されます。

戻り値
OptionUpdateRule