Opzione
public
abstract
@interface
Option
implements
Annotation
com.android.tradefed.config.Option |
Annota un campo come rappresenta un'opzione IConfiguration
.
Riepilogo
Costanti | |
---|---|
char |
NO_SHORT_NAME
|
Metodi pubblici | |
---|---|
String
|
description()
Descrizione semplice dell'opzione. |
Option.Importance
|
importance()
L'importanza dell'opzione. |
boolean
|
isTimeVal()
Indica se l'opzione rappresenta un valore temporale. |
boolean
|
mandatory()
Indica se l'opzione è obbligatoria o facoltativa. |
String
|
name()
Il nome univoco obbligatorio per questa opzione. |
boolean
|
requiredForRerun()
Indica se l'opzione è necessaria per compilare le istruzioni ed eseguire nuovamente un test. |
char
|
shortName()
Nome abbreviato facoltativo per l'opzione. |
OptionUpdateRule
|
updateRule()
Consente di controllare il comportamento quando un'opzione viene specificata più volte. |
Costanti
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Valore costante: 48 (0x00000030)
Metodi pubblici
descrizione
public String description ()
Descrizione semplice dell'opzione.
Ritorni | |
---|---|
String |
importanza
public Option.Importance importance ()
L'importanza dell'opzione.
Un'opzione considerata "importante" verrà visualizzato nell'output della guida abbreviato. Guida per un l'opzione non importante viene visualizzata solo nel testo della guida completo.
Ritorni | |
---|---|
Option.Importance |
valore isTime
public boolean isTimeVal ()
Indica se l'opzione rappresenta un valore temporale.
Se si tratta di un valore temporale, i suffissi specifici del tempo verranno analizzati. Il campo
Affinché questo flag sia valido, long
o Long
. In caso contrario, verrà generato un valore ConfigurationException
.
L'unità predefinita è in millisecondi. Il framework di configurazione accetterà s
per secondi
(1000 millisecondi), m
per minuti (60 secondi), h
per ore (60 minuti) o
d
per i giorni (24 ore).
Le unità possono essere miste e abbinate, a condizione che ciascuna unità venga visualizzata al massimo una volta e a condizione che
tutte le unità visualizzate sono elencate in ordine di scala decrescente. Ad esempio, h
potrebbe essere visualizzato solo prima del giorno m
e solo dopo il giorno d
. In base a un ruolo specifico,
esempio, "1d2h3m4s5ms" sarebbe un valore di tempo valido, così come "4" o "4 ms". Tutti incorporati
viene ignorato.
Ritorni | |
---|---|
boolean |
obbligatorio
public boolean mandatory ()
Indica se l'opzione è obbligatoria o facoltativa.
Il framework di configurazione genererà un ConfigurationException
se uno dei due
che segue è vero per un campo obbligatorio dopo l'analisi delle opzioni da tutte le origini:
- Il campo è
null
. - Il campo è un campo
ERROR(/Collection)
vuoto.
Ritorni | |
---|---|
boolean |
nome
public String name ()
Il nome univoco obbligatorio per questa opzione.
Verrà mappato a un argomento della riga di comando preceduto da due trattini '-' caratteri.
Ad esempio, un Option
con il nome "help" verrà specificato con "--help" il
dall'interfaccia a riga di comando.
I nomi non possono contenere i due punti, ad es. ":".
Ritorni | |
---|---|
String |
obbligatorioPerRerun
public boolean requiredForRerun ()
Indica se l'opzione è necessaria per compilare le istruzioni ed eseguire nuovamente un test.
Il segnalatore dei risultati può provare a compilare istruzioni su come eseguire nuovamente un test e includere il nel risultato. L'istruzione deve includere tutte le opzioni applicabili a un test eseguire di nuovo. Questo attributo viene utilizzato per indicare se l'opzione deve essere inclusa in tali istruzioni.
Ritorni | |
---|---|
boolean |
ShortName
public char shortName ()
Nome abbreviato facoltativo per l'opzione. Questo verrà mappato a un argomento della riga di comando preceduto da un singolo "-". ad es. "-h" dove h = shortName. "0" viene riservato per indicare che l'opzione non ha shortName.
Ritorni | |
---|---|
char |
updateRegola
public OptionUpdateRule updateRule ()
Consente di controllare il comportamento quando un'opzione viene specificata più volte. Tieni presente che questa regola è
completamente ignorato per le opzioni ERROR(/Collection)
o ERROR(/Map)
.
Ritorni | |
---|---|
OptionUpdateRule |