Option

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


Versieht ein Feld damit, dass es eine IConfiguration-Option darstellt.

Zusammenfassung

Konstanten

char NO_SHORT_NAME

Öffentliche Methoden

String description()

Nutzerfreundliche Beschreibung der Option.

Option.Importance importance()

Die Bedeutung der Option

boolean isTimeVal()

Gibt an, ob die Option einen Zeitwert darstellt.

boolean mandatory()

Gibt an, ob die Option obligatorisch oder optional ist.

String name()

Der obligatorische eindeutige Name für diese Option.

boolean requiredForRerun()

Gibt an, ob die Option zum Kompilieren einer Anweisung erforderlich ist, um einen Test noch einmal auszuführen.

char shortName()

Optionaler abgekürzter Name für Option.

OptionUpdateRule updateRule()

Steuert das Verhalten, wenn eine Option mehrmals angegeben wird.

Konstanten

NO_SHORT_NAME

public static final char NO_SHORT_NAME

Konstantenwert: 48 (0x00000030)

Öffentliche Methoden

Beschreibung

public String description ()

Nutzerfreundliche Beschreibung der Option.

Returns
String

Wichtigkeit

public Option.Importance importance ()

Die Bedeutung der Option

Eine als „wichtig“ betrachtete Option wird in der abgekürzten Hilfeausgabe angezeigt. Hilfe für ein werden nur im vollständigen Hilfetext angezeigt.

Returns
Option.Importance

isTimeVal (Zeitwert)

public boolean isTimeVal ()

Gibt an, ob die Option einen Zeitwert darstellt.

Wenn es sich um einen Zeitwert handelt, werden zeitspezifische Suffixe geparst. Das Feld MÜSSEN long oder Long sein, damit dieses Flag gültig ist. Andernfalls wird ConfigurationException ausgegeben.

Die Standardeinheit ist Millisekunden. Das Konfigurations-Framework akzeptiert s für Sekunden. (1.000 Millis), m für Minuten (60 Sekunden), h für Stunden (60 Minuten) oder d für Tage (24 Stunden).

Die Einheiten können gemischt und miteinander kombiniert werden, solange jede Einheit maximal einmal erscheint und solange werden alle Einheiten, die angezeigt werden, in absteigender Reihenfolge aufgelistet. Beispielsweise darf h nur vor m und erst nach d stehen. Als spezifische Beispiel: „1d2h3m4s5ms“ wäre ein gültiger Zeitwert, wie z. B. „4“. oder „4 ms“. Alle eingebetteten wird verworfen.

Returns
boolean

obligatorisch

public boolean mandatory ()

Gibt an, ob die Option obligatorisch oder optional ist.

Das Konfigurations-Framework gibt ConfigurationException aus, wenn einer der Folgendes gilt für ein Pflichtfeld, nachdem Optionen aus allen Quellen geparst wurden:

Returns
boolean

Name

public String name ()

Der obligatorische eindeutige Name für diese Option.

Dies wird einem Befehlszeilenargument mit dem Präfix zwei „-“ zugeordnet. Zeichen. Beispiel: Option mit dem Namen „help“ mit "--help" angegeben, am Befehlszeile.

Namen dürfen keinen Doppelpunkt enthalten, z. B. „:“.

Returns
String

requiredForRerun

public boolean requiredForRerun ()

Gibt an, ob die Option zum Kompilieren einer Anweisung erforderlich ist, um einen Test noch einmal auszuführen.

Der Ergebnismelder kann versuchen, eine Anleitung zum erneuten Ausführen eines Tests zusammenzustellen und den im Ergebnis. Die Anweisung muss alle Optionen enthalten, die für eine Prüfung anwendbar sind. den Sie wiederholt ausführen. Mit diesem Attribut wird angegeben, ob die Option in solchen Anleitung.

Returns
boolean

Kurzname

public char shortName ()

Optionaler abgekürzter Name für Option. Dies wird einem Befehlszeilenargument mit einem vorangestellten einzelnen "-" zugeordnet. z.B. „-h“ wobei h = shortName. „0“ reserviert, d. h., die Option hat keinen shortName.

Returns
char

Aktualisierungsregel

public OptionUpdateRule updateRule ()

Steuert das Verhalten, wenn eine Option mehrmals angegeben wird. Beachten Sie, dass diese Regel für Optionen, die ERROR(/Collection) oder ERROR(/Map) sind, vollständig ignoriert.

Returns
OptionUpdateRule