Opcja
public
abstract
@interface
Option
implements
Annotation
| com.android.tradefed.config.Option |
Oznacza pole jako reprezentujące opcję IConfiguration.
Podsumowanie
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()
Określa, 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 ponownego uruchomienia testu. |
char
|
shortName()
Opcjonalna skrócona nazwa opcji. |
OptionUpdateRule
|
updateRule()
Określa zachowanie, gdy opcja jest podana wiele razy. |
Stałe
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Wartość stała: 48 (0x00000030)
Metody publiczne
description
public String description ()
Przyjazny dla użytkownika opis opcji.
| Zwraca | |
|---|---|
String |
|
importance
public Option.Importance importance ()
Znaczenie opcji.
Opcja uznana za „ważną” będzie wyświetlana w skróconym wyniku pomocy. Pomoc dotycząca nieważnej opcji będzie wyświetlana tylko w pełnym tekście pomocy.
| Zwraca | |
|---|---|
Option.Importance |
|
isTimeVal
public boolean isTimeVal ()
Określa, czy opcja reprezentuje wartość czasu.
Jeśli jest to wartość czasu, zostaną przeanalizowane sufiksy specyficzne dla czasu. Aby ta flaga była prawidłowa, pole
long lub Long. W przeciwnym razie zostanie zgłoszony wyjątek ConfigurationException.
Domyślną jednostką są milisekundy. 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 można łączyć, o ile każda jednostka występuje co najwyżej raz i o ile
wszystkie występujące jednostki są wymienione w kolejności malejącej skali. Na przykład h może występować tylko przed m i tylko po d. Na przykład
„1d2h3m4s5ms” byłaby prawidłową wartością czasu, podobnie jak „4” lub „4ms”. Wszystkie osadzone
białe znaki są odrzucane.
| Zwraca | |
|---|---|
boolean |
|
mandatory
public boolean mandatory ()
Określa, czy opcja jest obowiązkowa czy opcjonalna.
Framework konfiguracji zgłosi ConfigurationException jeśli po przeanalizowaniu opcji ze wszystkich źródeł spełniony jest jeden z tych
warunków:
- Pole ma wartość
null. - Pole jest pustą
Collection.
| Zwraca | |
|---|---|
boolean |
|
name
public String name ()
Obowiązkowa, unikalna nazwa tej opcji.
Będzie to odpowiadać argumentowi wiersza poleceń poprzedzonemu 2 znakami „-”.
Na przykład Option o nazwie „help” będzie określana w wierszu poleceń za pomocą „--help” na.
Nazwy nie mogą zawierać dwukropka, np. „:”.
| Zwraca | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
Określa, czy opcja jest potrzebna do skompilowania instrukcji ponownego uruchomienia testu.
Reporter wyników może spróbować skompilować instrukcje dotyczące ponownego uruchomienia testu i umieścić wiadomość w wyniku. Instrukcja powinna zawierać wszystkie opcje, które mają zastosowanie do ponownego uruchomienia testu. Ten atrybut służy do określenia, czy opcja ma być uwzględniona w takiej instrukcji.
| Zwraca | |
|---|---|
boolean |
|
shortName
public char shortName ()
Opcjonalna skrócona nazwa opcji. Będzie to odpowiadać argumentowi wiersza poleceń poprzedzonemu pojedynczym znakiem „-”. np. „-h”, gdzie h = shortName. „0” jest zarezerwowane i oznacza, że opcja nie ma krótkiej nazwy.
| Zwraca | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
Określa zachowanie, gdy opcja jest podana wiele razy. Pamiętaj, że ta reguła jest
całkowicie ignorowana w przypadku opcji, które są Collection lub Map.
| Zwraca | |
|---|---|
OptionUpdateRule |
|