Opcja
public abstract @interface Option
implements Annotation
com.android.tradefed.config.Option |
Adnotuje pole jako reprezentujące opcję IConfiguration
.
Streszczenie
Klasy zagnieżdżone | |
---|---|
enum | Option.Importance
|
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 unikalna 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 (0x0000030)
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 będzie wyświetlana tylko w pełnym tekście pomocy.Zwroty | |
---|---|
Option.Importance |
isTimeVal
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 ConfigurationException
.
Domyślną jednostką jest milis. Struktura konfiguracji zaakceptuje s
dla sekund (1000 milisów), m
dla minut (60 sekund), h
dla godzin (60 minut) lub d
dla dni (24 godziny).
Jednostki mogą być mieszane i dopasowywane, o ile każda jednostka pojawia się co najwyżej raz i tak długo, jak 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 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ązkowe
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 dla pola obowiązkowego:- Pole ma
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' zostałaby 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.
Osoba zgłaszająca wyniki może próbować skompilować instrukcję, jak powtórzyć test i dołączyć komunikat do wyniku. Instrukcja powinna zawierać wszystkie opcje mające zastosowanie do ponownego uruchomienia testu. Atrybut ten służy do wskazania, czy opcja powinna być 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 = nazwa skrócona. '0' jest zarezerwowane, aby oznaczać, że opcja nie ma krótkiej nazwy.
Zwroty | |
---|---|
char |
aktualizacjaRule
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)
lub ERROR(/Map)
.
Zwroty | |
---|---|
OptionUpdateRule |
Treść strony i umieszczone na niej fragmenty kodu podlegają licencjom opisanym w Licencji na treści. Java i OpenJDK są znakami towarowymi lub zastrzeżonymi znakami towarowymi należącymi do firmy Oracle lub jej podmiotów stowarzyszonych.
Last updated 2022-08-15 UTC.