Option
public
abstract
@interface
Option
implements
Annotation
com.android.tradefed.config.Option |
Oznaczy pole jako reprezentujące opcję IConfiguration
.
Podsumowanie
Stałe | |
---|---|
char |
NO_SHORT_NAME
|
Metody publiczne | |
---|---|
String
|
description()
Przystępny opis opcji. |
Option.Importance
|
importance()
Znaczenie tej opcji. |
boolean
|
isTimeVal()
Czy opcja reprezentuje wartość czasową. |
boolean
|
mandatory()
Określ, czy opcja jest obowiązkowa czy opcjonalna. |
String
|
name()
Wymagana unikalna nazwa tej opcji. |
boolean
|
requiredForRerun()
Czy ta opcja jest potrzebna do skompilowania instrukcji ponownego uruchomienia testu. |
char
|
shortName()
Opcjonalna skrócona nazwa opcji. |
OptionUpdateRule
|
updateRule()
Określa działanie, gdy dana 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 ()
Przystępny opis opcji.
Zwroty | |
---|---|
String |
ważność
public Option.Importance importance ()
Ważność opcji.
Opcja uznana za „ważną” będzie wyświetlana w skrócie pomocy. Pomoc dotycząca opcji o mniejszym znaczeniu 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, zostaną zanalizowane sufiksy czasowe. Aby ta flaga była prawidłowa, pole long
lub Long
. W przeciwnym razie zostanie odrzucony element ConfigurationException
.
Domyślna jednostka to milisekunda. Platforma konfiguracji akceptuje s
w przypadku sekund (1000 milisekund), m
w przypadku minut (60 sekund), h
w przypadku godzin (60 minut) lub d
w przypadku dni (24 godzin).
Jednostki mogą być mieszane i dopasowane, o ile każda z nich pojawia się maksymalnie raz i o ile wszystkie wyświetlane jednostki są wymienione w kolejności malejącej. Na przykład h
może pojawić się tylko przed m
i tylko po d
. Prawidłową wartością czasu jest np. „1d2h3m4s5ms”, tak jak „4” lub „4 ms”. Wszystkie osadzone spacje zostaną pominięte.
Zwroty | |
---|---|
boolean |
obowiązkowe
public boolean mandatory ()
Określa, czy ta opcja jest obowiązkowa czy opcjonalna.
Platforma konfiguracji zgłasza żądanie ConfigurationException
, jeśli po przeanalizowaniu opcji ze wszystkich źródeł jest spełniony jeden z tych warunków w przypadku obowiązkowego pola:
- Pole to
null
. - Pole
ERROR(/Collection)
jest puste.
Zwroty | |
---|---|
boolean |
nazwa
public String name ()
Wymagana unikalna nazwa tej opcji.
Spowoduje to mapowanie na argument wiersza poleceń z prefiksem 2 znaków „-”.
Na przykład do polecenia Option
o nazwie „help” wpisz „--help” w wierszu poleceń.
Nazwy nie mogą zawierać dwukropka, np. „:”.
Zwroty | |
---|---|
String |
requiredForRerun
public boolean requiredForRerun ()
Czy ta opcja jest potrzebna do skompilowania instrukcji ponownego uruchomienia testu.
Osoba zgłaszająca wyniki może spróbować skompilować instrukcje ponownego uruchomienia testu i umieścić w wynikach wiadomość. Instrukcja powinna zawierać wszystkie opcje dotyczące ponownego uruchomienia testu. Ten atrybut wskazuje, czy opcja ma być uwzględniona w instrukcji.
Zwroty | |
---|---|
boolean |
shortName
public char shortName ()
Opcjonalna skrócona nazwa opcji. Zostanie on zmapowany na argument wiersza poleceń z preiksem „-”. Przykład: „-h”, gdzie h = shortName. „0” jest zarezerwowany dla opcji, która nie ma wartości ShortName.
Zwroty | |
---|---|
char |
updateRule (Reguła aktualizacji)
public OptionUpdateRule updateRule ()
Kontroluje zachowanie w przypadku, gdy dana opcja zostanie określona wiele razy. Pamiętaj, że ta reguła jest całkowicie ignorowana w przypadku opcji ERROR(/Collection)
s lub ERROR(/Map)
s.
Zwroty | |
---|---|
OptionUpdateRule |