Option

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option

Hiermit wird angegeben, dass ein Feld eine IConfiguration-Option darstellt.

Zusammenfassung

Konstanten

char NO_SHORT_NAME

Öffentliche Methoden

String description()

Eine nutzerfreundliche Beschreibung der Option.

Option.Importance importance()

Die Bedeutung der Option.

boolean isTimeVal()

Gibt an, ob die Option einen Zeitwert darstellt.

boolean mandatory()

Ob die Option obligatorisch oder optional ist.

String name()

Der obligatorische eindeutige Name für diese Option.

boolean requiredForRerun()

Gibt an, ob die Option erforderlich ist, um eine Anleitung zum erneuten Ausführen eines Tests zu erstellen.

char shortName()

Optionaler abgekürzter Name für Option.

OptionUpdateRule updateRule()

Hiermit wird das Verhalten festgelegt, 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 ()

Eine nutzerfreundliche Beschreibung der Option.

Returns
String

Wichtigkeit

public Option.Importance importance ()

Die Bedeutung der Option.

Eine als „wichtig“ eingestufte Option wird in der Kurzausgabe der Hilfe angezeigt. Hilfe zu einer unwichtigen Option wird 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 eine ConfigurationException geworfen.

Die Standardeinheit ist „millis“. Das Konfigurationsframework akzeptiert s für Sekunden (1.000 Millisekunden), 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 höchstens einmal erscheint und alle Einheiten, die tatsächlich angezeigt werden, in absteigender Reihenfolge aufgelistet sind. So kann h beispielsweise nur vor m und nach d erscheinen. „1d2h3m4s5ms“ ist ein gültiges Beispiel für einen Zeitwert, ebenso wie „4“ oder „4ms“. Alle eingebetteten Leerzeichen werden verworfen.

Returns
boolean

obligatorisch

public boolean mandatory ()

Ob die Option obligatorisch oder optional ist.

Das Konfigurations-Framework gibt eine ConfigurationException zurück, wenn für ein Pflichtfeld nach dem Parsen der Optionen aus allen Quellen einer der folgenden Punkte zutrifft:

Returns
boolean

Name

public String name ()

Der obligatorische eindeutige Name für diese Option.

Dies wird einem Befehlszeilenargument zugeordnet, das mit zwei „-“-Zeichen beginnt. Ein Option mit dem Namen „help“ würde beispielsweise in der Befehlszeile mit „–help“ angegeben.

Namen dürfen kein Doppelpunktzeichen enthalten, z. B. „:“.

Returns
String

requiredForRerun

public boolean requiredForRerun ()

Gibt an, ob die Option erforderlich ist, um eine Anleitung zum erneuten Ausführen eines Tests zu kompilieren.

Der Ersteller des Ergebnisses kann versuchen, eine Anleitung zum Wiederholen eines Tests zusammenzustellen und die Meldung in das Ergebnis aufzunehmen. Die Anleitung muss alle Optionen enthalten, die für die Wiederholung eines Tests gelten. Mit diesem Attribut wird angegeben, ob die Option in eine solche Anleitung aufgenommen werden soll.

Returns
boolean

Kurzname

public char shortName ()

Optionaler abgekürzter Name für Option. Dies wird einem Befehlszeilenargument mit einem einzelnen „-“ als Präfix zugeordnet, z. B. „-h“, wobei h = shortName. „0“ bedeutet, dass die Option keinen shortName hat.

Returns
char

updateRule

public OptionUpdateRule updateRule ()

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

Returns
OptionUpdateRule