Möglichkeit
public abstract @interface Option
implements Annotation
com.android.tradefed.config.Option |
Kommentiert ein Feld als Darstellung einer IConfiguration
Option.
Zusammenfassung
Konstanten | |
---|---|
char | NO_SHORT_NAME
|
Öffentliche Methoden | |
---|---|
String | description () Benutzerfreundliche Beschreibung der Option. |
Option.Importance | importance () Die Bedeutung der Option. |
boolean | isTimeVal () 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 () Ob die Option zum Kompilieren von Anweisungen zum erneuten Ausführen eines Tests benötigt wird. |
char | shortName () Optionaler abgekürzter Name für die Option. |
OptionUpdateRule | updateRule () Steuert das Verhalten, 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 ()
Benutzerfreundliche Beschreibung der Option.
Kehrt zurück | |
---|---|
String |
Bedeutung
public Option.Importance importance ()
Die Bedeutung der Option.
Eine als „wichtig“ erachtete Option wird in der gekürzten Hilfeausgabe angezeigt. Hilfe zu einer unwichtigen Option wird nur im vollständigen Hilfetext angezeigt.Kehrt zurück | |
---|---|
Option.Importance |
isTimeVal
public boolean isTimeVal ()
Ob die Option einen Zeitwert darstellt.
Wenn es sich um einen Zeitwert handelt, werden zeitspezifische Suffixe geparst. Das Feldlong
oder Long
sein, damit dieses Flag gültig ist. Andernfalls wird eine ConfigurationException
ausgelöst.
Die Standardeinheit ist Millis. Das Konfigurationsframework akzeptiert s
für Sekunden (1000 Millisekunden), m
für Minuten (60 Sekunden), h
für Stunden (60 Minuten) oder d
für Tage (24 Stunden).
Einheiten können gemischt und kombiniert werden, solange jede Einheit höchstens einmal vorkommt und alle Einheiten, die erscheinen, in absteigender Reihenfolge der Skala aufgelistet sind. So darf h
beispielsweise nur vor m
und nur nach d
erscheinen. Als konkretes Beispiel wäre „1d2h3m4s5ms“ ein gültiger Zeitwert, ebenso wie „4“ oder „4ms“. Alle eingebetteten Leerzeichen werden verworfen.
Kehrt zurück | |
---|---|
boolean |
obligatorisch
public boolean mandatory ()
Ob die Option obligatorisch oder optional ist.
Das Konfigurationsframework löst eineConfigurationException
aus, wenn eine der folgenden Bedingungen auf ein Pflichtfeld zutrifft, nachdem Optionen aus allen Quellen analysiert wurden:- Das Feld ist
null
. - Das Feld ist leer
ERROR(/Collection)
.
Kehrt zurück | |
---|---|
boolean |
Name
public String name ()
Der obligatorische eindeutige Name für diese Option.
Dies wird einem Befehlszeilenargument zugeordnet, dem zwei „-“-Zeichen vorangestellt sind. Beispielsweise würde eineOption
mit dem Namen „help“ mit „--help“ in der Befehlszeile angegeben. Namen dürfen keinen Doppelpunkt enthalten, z. B. „:“.Kehrt zurück | |
---|---|
String |
erforderlichForRerun
public boolean requiredForRerun ()
Ob die Option zum Kompilieren von Anweisungen zum erneuten Ausführen eines Tests benötigt wird.
Der Ergebnisberichterstatter versucht möglicherweise, Anweisungen zum erneuten Ausführen eines Tests zusammenzustellen und die Meldung in das Ergebnis aufzunehmen. Die Anweisung muss alle Optionen umfassen, die für eine Testwiederholung gelten. Dieses Attribut wird verwendet, um anzugeben, ob die Option in einer solchen Anweisung enthalten sein soll.
Kehrt zurück | |
---|---|
boolean |
kurzer Name
public char shortName ()
Optionaler abgekürzter Name für die Option. Dies wird einem Befehlszeilenargument zugeordnet, dem ein einzelnes „-“ vorangestellt ist. zB „-h“, wobei h = Kurzname. „0“ ist reserviert, was bedeutet, dass die Option keinen Kurznamen hat.
Kehrt zurück | |
---|---|
char |
updateRule
public OptionUpdateRule updateRule ()
Steuert das Verhalten, 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.
Kehrt zurück | |
---|---|
OptionUpdateRule |