Google は、黒人コミュニティに対する人種平等の促進に取り組んでいます。取り組みを見る
このページは Cloud Translation API によって翻訳されました。
Switch to English

オプション

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


IConfigurationオプションを表すものとしてフィールドに注釈を付けます。

概要

ネストされたクラス

enum Option.Importance

定数

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

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

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

戻り値
boolean

必須の

public boolean mandatory ()

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

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

戻り値
boolean

名前

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