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()
Ważność 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 ()
Czy opcja reprezentuje wartość czasową.
Jeśli jest to wartość czasu, zostaną zanalizowane sufiksy czasowe. Aby ten parametr był prawidłowy, pole musi long lub Long. W przeciwnym razie zostanie ConfigurationException.
Domyślna jednostka to milisekunda. Framework konfiguracji akceptuje s dla sekund (1000 milisekund), m dla minut (60 sekund), h dla godzin (60 minut) lub d dla dni (24 godziny).
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. Przykładowo „1d2h3m4s5ms” to prawidłowa wartość czasu, podobnie jak „4” lub „4ms”. Wszystkie osadzone spacje są pomijane.
| Zwroty | |
|---|---|
boolean |
|
obowiązkowe
public boolean mandatory ()
Czy opcja jest obowiązkowa czy opcjonalna.
Jeśli po przeanalizowaniu opcji ze wszystkich źródeł w przypadku pola obowiązkowego spełniony jest jeden z tych warunków, framework konfiguracji ConfigurationException:
- To pole to
null. - Pole jest puste
ERROR(/Collection).
| 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 Option o nazwie „help” można określić za pomocą parametru „--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.
Raport z wynikiem może zawierać instrukcje ponownego uruchomienia testu i odpowiednią wiadomość. Instrukcje muszą zawierać wszystkie opcje, które można zastosować do 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. Wartość „0” oznacza, że opcja nie ma nazwy krótkiej.
| Zwroty | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
Określa działanie, gdy dana opcja jest określona wielokrotnie. Pamiętaj, że ta reguła jest całkowicie ignorowana w przypadku opcji ERROR(/Collection)s lub ERROR(/Map)s.
| Zwroty | |
|---|---|
OptionUpdateRule |
|