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 kompilieren. |
char
|
shortName()
Optionaler abgekürzter Name für die 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
Konstanter Wert: 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
public boolean isTimeVal ()
Gibt an, ob die Option einen Zeitwert darstellt.
Wenn es sich um einen Zeitwert handelt, werden zeitspezifische Suffixe analysiert. Das Feld 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).
Einheiten können kombiniert werden, solange jede Einheit höchstens einmal vorkommt und alle Einheiten in absteigender Reihenfolge nach Skala aufgeführt 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:
- Das Feld ist
null. - Das Feld ist eine leere
ERROR(/Collection).
| 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 erstellen.
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 |
|
shortName
public char shortName ()
Optionaler abgekürzter Name für die Option. Dies wird einem Befehlszeilenargument zugeordnet, das mit einem einzelnen „-“ beginnt. Beispiel: „-h“, wobei „h“ für „shortName“ steht. „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 vom Typ ERROR(/Collection) oder ERROR(/Map) vollständig ignoriert wird.
| Returns | |
|---|---|
OptionUpdateRule |
|