Option

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option

Kennzeichnet ein Feld als Option für IConfiguration.

Zusammenfassung

Konstanten

char NO_SHORT_NAME

Öffentliche Methoden

String description()

Nutzerfreundliche Beschreibung der Option.

Option.Importance importance()

Wichtigkeit 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 erforderlich ist, um eine Anleitung zum erneuten Ausführen eines Tests zu erstellen.

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 ()

Nutzerfreundliche Beschreibung der Option.

Gibt Folgendes zurück:
String

Wichtigkeit

public Option.Importance importance ()

Wichtigkeit der Option.

Eine als „wichtig“ eingestufte Option wird in der abgekürzten Hilfeausgabe angezeigt. Die Hilfe für eine unwichtige Option wird nur im vollständigen Hilfetext angezeigt.

Gibt Folgendes zurück:
Option.Importance

isTimeVal

public boolean isTimeVal ()

Gibt an, ob die Option einen Zeitwert darstellt.

Wenn es sich um einen Zeitwert handelt, werden zeitspezifische Suffixe geparst. Das Feld MUSS ein long oder Long sein, damit dieses Flag gültig ist. Andernfalls wird eine ConfigurationException ausgelöst.

Die Standardeinheit ist Millisekunden. 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, sofern jede Einheit höchstens einmal vorkommt und alle Einheiten in absteigender Reihenfolge der Größe aufgeführt sind. So kann h beispielsweise nur vor m und nur nach d vorkommen. Ein konkretes Beispiel: „1d2h3m4s5ms“ wäre ein gültiger Zeitwert, ebenso wie „4“ oder „4ms“. Alle eingebetteten Leerzeichen werden verworfen.

Gibt Folgendes zurück:
boolean

obligatorisch

public boolean mandatory ()

Gibt an, ob die Option obligatorisch oder optional ist.

Das Konfigurationsframework löst eine ConfigurationException aus, wenn eine der folgenden Bedingungen für ein Pflichtfeld zutrifft, nachdem Optionen aus allen Quellen geparst wurden:

  • Das Feld ist null.
  • Das Feld ist eine leere Collection.

Gibt Folgendes zurück:
boolean

Name

public String name ()

Der obligatorische eindeutige Name für diese Option.

Dies wird einem Befehlszeilenargument zugeordnet, dem zwei Minuszeichen vorangestellt sind. Ein Option mit dem Namen „help“ wird beispielsweise in der Befehlszeile mit „--help“ angegeben.

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

Gibt Folgendes zurück:
String

requiredForRerun

public boolean requiredForRerun ()

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

Der Ergebnisreporter kann versuchen, eine Anleitung zum erneuten Ausführen eines Tests zu erstellen und die Nachricht in das Ergebnis aufzunehmen. Die Anleitung muss alle Optionen enthalten, die für die erneute Ausführung eines Tests gelten. Mit diesem Attribut wird angegeben, ob die Option in eine solche Anleitung aufgenommen werden soll.

Gibt Folgendes zurück:
boolean

shortName

public char shortName ()

Optionaler abgekürzter Name für die Option. Dies wird einem Befehlszeilenargument zugeordnet, dem ein einzelnes Minuszeichen vorangestellt ist. z.B. „-h“, wobei „h“ für „shortName“ steht. „0“ ist reserviert und bedeutet, dass die Option keinen Kurznamen hat.

Gibt Folgendes zurück:
char

updateRule

public OptionUpdateRule updateRule ()

Steuert das Verhalten, wenn eine Option mehrmals angegeben wird. Diese Regel wird für Optionen, die Collections oder Maps sind, vollständig ignoriert.

Gibt Folgendes zurück:
OptionUpdateRule