Opcja
public abstract @interface Option
implements Annotation
com.android.tradefed.config.Option |
Adnotuje pole jako reprezentujące opcję IConfiguration
.
Streszczenie
Stałe | |
---|---|
char | NO_SHORT_NAME
|
Metody publiczne | |
---|---|
String | description () Przyjazny dla użytkownika opis opcji. |
Option.Importance | importance () Znaczenie opcji. |
boolean | isTimeVal () Określa, czy opcja reprezentuje wartość czasu. |
boolean | mandatory () Czy opcja jest obowiązkowa czy opcjonalna. |
String | name () Obowiązkowa unikalna nazwa tej opcji. |
boolean | requiredForRerun () Określa, czy opcja jest potrzebna do skompilowania instrukcji w celu ponownego uruchomienia testu. |
char | shortName () Opcjonalna skrócona nazwa opcji. |
OptionUpdateRule | updateRule () Kontroluje zachowanie, gdy opcja jest określona wielokrotnie. |
Stałe
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Wartość stała: 48 (0x00000030)
Metody publiczne
opis
public String description ()
Przyjazny dla użytkownika opis opcji.
Zwroty | |
---|---|
String |
znaczenie
public Option.Importance importance ()
Znaczenie opcji.
Opcja uznana za „ważną” zostanie wyświetlona w skróconym komunikacie pomocy. Pomoc dotycząca nieistotnej opcji będzie wyświetlana tylko w pełnym tekście pomocy.Zwroty | |
---|---|
Option.Importance |
isTimeVal
public boolean isTimeVal ()
Określa, czy opcja reprezentuje wartość czasu.
Jeśli jest to wartość czasu, analizowane będą przyrostki specyficzne dla czasu. Polelong
lub Long
, aby ta flaga była ważna. W przeciwnym razie zostanie zgłoszony wyjątek ConfigurationException
.
Domyślną jednostką są milis. Struktura konfiguracji akceptuje s
dla sekund (1000 milisekund), m
dla minut (60 sekund), h
dla godzin (60 minut) lub d
dla dni (24 godziny).
Jednostki można mieszać i dopasowywać, pod warunkiem, że każda jednostka pojawi się najwyżej raz i pod warunkiem, że wszystkie jednostki, które się pojawią, zostaną wymienione w malejącej kolejności skali. Na przykład h
może pojawić się tylko przed m
i może pojawić się tylko po d
. Jako konkretny przykład, „1d2h3m4s5ms” będzie prawidłową wartością czasu, podobnie jak „4” lub „4ms”. Wszystkie osadzone białe znaki są odrzucane.
Zwroty | |
---|---|
boolean |
obowiązkowy
public boolean mandatory ()
Czy opcja jest obowiązkowa czy opcjonalna.
Struktura konfiguracji zgłosi wyjątekConfigurationException
, jeśli spełniony jest którykolwiek z poniższych warunków w odniesieniu do pola obowiązkowego po przeanalizowaniu opcji ze wszystkich źródeł:- Pole ma wartość
null
. - Pole jest pustym
ERROR(/Collection)
.
Zwroty | |
---|---|
boolean |
nazwa
public String name ()
Obowiązkowa unikalna nazwa tej opcji.
Spowoduje to odwzorowanie na argument wiersza poleceń poprzedzony dwoma znakami „-”. Na przykładOption
o nazwie „help” zostanie określona za pomocą „--help” w wierszu poleceń. Nazwy nie mogą zawierać dwukropka, np. „:”.Zwroty | |
---|---|
String |
wymagane do ponownego uruchomienia
public boolean requiredForRerun ()
Określa, czy opcja jest potrzebna do skompilowania instrukcji w celu ponownego uruchomienia testu.
Osoba zgłaszająca wyniki może spróbować skompilować instrukcję dotyczącą ponownego przeprowadzenia testu i dołączyć tę wiadomość do wyniku. Instrukcja powinna zawierać wszystkie opcje mające zastosowanie w przypadku powtórzenia testu. Atrybut ten służy do wskazania, czy opcja ma zostać uwzględniona w takiej instrukcji.
Zwroty | |
---|---|
boolean |
krótkie imię
public char shortName ()
Opcjonalna skrócona nazwa opcji. Spowoduje to odwzorowanie na argument wiersza poleceń poprzedzony pojedynczym „-”. np. „-h”, gdzie h = krótka nazwa. „0” jest zarezerwowane i oznacza, że opcja nie ma krótkiej nazwy.
Zwroty | |
---|---|
char |
aktualizacjaReguły
public OptionUpdateRule updateRule ()
Kontroluje zachowanie, gdy opcja jest określona wielokrotnie. Należy zauważyć, że ta reguła jest całkowicie ignorowana w przypadku opcji typu ERROR(/Collection)
lub ERROR(/Map)
.
Zwroty | |
---|---|
OptionUpdateRule |