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 erforderlich ist. |
char | shortName () Optionaler abgekürzter Name für Option. |
OptionUpdateRule | updateRule () Steuert das Verhalten, wenn eine Option mehrfach 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“ eingestufte Option wird in der verkü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 analysiert. Das Feldlong
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 (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 erscheint und solange alle erscheinenden Einheiten in absteigender Reihenfolge der Skala aufgeführt sind. So darf beispielsweise h
nur vor m
und erst nach d
stehen. Als spezifisches 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 für ein Pflichtfeld gilt, nachdem Optionen aus allen Quellen analysiert wurden:- Das Feld ist
null
. - Das Feld ist ein leerer
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 werden. Namen dürfen keinen Doppelpunkt enthalten, zB ':'.Kehrt zurück | |
---|---|
String |
erforderlichForRerun
public boolean requiredForRerun ()
Ob die Option zum Kompilieren von Anweisungen zum erneuten Ausführen eines Tests erforderlich ist.
Der Ergebnisberichterstatter kann versuchen, Anweisungen zur Wiederholung eines Tests zusammenzustellen und die Nachricht in das Ergebnis aufzunehmen. Die Anweisung muss alle Optionen enthalten, 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 Option. Dies wird einem Befehlszeilenargument zugeordnet, dem ein einzelnes „-“ vorangestellt ist. zB "-h" wobei h = shortName. '0' ist reserviert, um zu bedeuten, dass die Option keinen shortName hat.
Kehrt zurück | |
---|---|
char |
updateRule
public OptionUpdateRule updateRule ()
Steuert das Verhalten, wenn eine Option mehrfach 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 |