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 () Czy opcja reprezentuje wartość czasu. |
boolean | mandatory () Czy opcja jest obowiązkowa, czy opcjonalna. |
String | name () Obowiązkowa unikatowa nazwa tej opcji. |
boolean | requiredForRerun () Czy opcja jest potrzebna do skompilowania instrukcji w celu ponownego uruchomienia testu. |
char | shortName () Opcjonalna skrócona nazwa opcji. |
OptionUpdateRule | updateRule () Steruje zachowaniem, gdy opcja jest określona wiele razy. |
Stałe
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Stała wartość: 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 wyjściu pomocy. Pomoc dotycząca nieistotnej opcji zostanie wyświetlona tylko w pełnym tekście pomocy.Zwroty | |
---|---|
Option.Importance |
jestWartCzasu
public boolean isTimeVal ()
Czy opcja reprezentuje wartość czasu.
Jeśli jest to wartość czasu, zostaną przeanalizowane sufiksy 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ą milisy. 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ć, o ile każda jednostka pojawia się co najwyżej raz, a wszystkie jednostki, które się pojawiają, są wymienione w malejącej kolejności skali. Na przykład h
może pojawić się tylko przed m
i tylko po d
. W konkretnym przykładzie „1d2h3m4s5ms” byłoby prawidłową wartością czasu, podobnie jak „4” lub „4ms”. Wszystkie osadzone spacje są odrzucane.
Zwroty | |
---|---|
boolean |
obowiązkowy
public boolean mandatory ()
Czy opcja jest obowiązkowa, czy opcjonalna.
Struktura konfiguracji zgłosi wyjątekConfigurationException
, jeśli po przeanalizowaniu opcji ze wszystkich źródeł spełniony jest jeden z poniższych warunków w polu obowiązkowym:- Pole jest
null
. - Pole jest puste
ERROR(/Collection)
.
Zwroty | |
---|---|
boolean |
nazwa
public String name ()
Obowiązkowa unikatowa nazwa tej opcji.
Spowoduje to odwzorowanie argumentu wiersza poleceń poprzedzonego dwoma znakami „-”. Na przykładOption
o nazwie „pomoc” zostanie określona z „--help” w wierszu poleceń. Nazwy nie mogą zawierać dwukropka, np. „:”.Zwroty | |
---|---|
String |
wymagane do ponownego uruchomienia
public boolean requiredForRerun ()
Czy opcja jest potrzebna do skompilowania instrukcji w celu ponownego uruchomienia testu.
Reporter wyników może próbować skompilować instrukcję, jak ponownie przeprowadzić test i dołączyć komunikat do wyniku. Instrukcja zawiera wszystkie opcje, które mają zastosowanie do ponownego uruchomienia testu. Atrybut ten służy do wskazania, czy opcja powinna zostać uwzględniona w takiej dyspozycji.
Zwroty | |
---|---|
boolean |
krótkie imię
public char shortName ()
Opcjonalna skrócona nazwa opcji. Spowoduje to odwzorowanie argumentu wiersza poleceń poprzedzonego pojedynczym „-”. np. „-h”, gdzie h = krótka nazwa. „0” jest zarezerwowane, aby oznaczać, że opcja nie ma krótkiej nazwy.
Zwroty | |
---|---|
char |
aktualizacjareguły
public OptionUpdateRule updateRule ()
Steruje zachowaniem, gdy opcja jest określona wiele razy. Zauważ, że ta reguła jest całkowicie ignorowana dla opcji, które są ERROR(/Collection)
s lub ERROR(/Map)
s.
Zwroty | |
---|---|
OptionUpdateRule |