Opzione
public
abstract
@interface
Option
implements
Annotation
com.android.tradefed.config.Option |
Consente di annotare un campo come rappresentante un'opzione IConfiguration
.
Riepilogo
Costanti | |
---|---|
char |
NO_SHORT_NAME
|
Metodi pubblici | |
---|---|
String
|
description()
Descrizione dell'opzione facile da usare. |
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 l'istruzione per eseguire di nuovo un test. |
char
|
shortName()
Nome abbreviato facoltativo per l'opzione. |
OptionUpdateRule
|
updateRule()
Controlla 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 dell'opzione facile da usare.
Ritorni | |
---|---|
String |
importanza
public Option.Importance importance ()
L'importanza dell'opzione.
Un'opzione considerata "importante" verrà visualizzata nell'output della guida abbreviata. La guida per un'opzione non importante verrà visualizzata solo nel testo completo della guida.
Ritorni | |
---|---|
Option.Importance |
isTimeVal
public boolean isTimeVal ()
Indica se l'opzione rappresenta un valore temporale.
Se si tratta di un valore di tempo, verranno analizzati i suffissi specifici per il tempo. Affinché questo flag sia valido, il campo long
o Long
. In caso contrario, verrà generato un ConfigurationException
.
L'unità predefinita è in millisecondi. Il framework di configurazione accetterà s
per i secondi
(1000 millisecondi), m
per i minuti (60 secondi), h
per le ore (60 minuti) o
d
per i giorni (24 ore).
Le unità possono essere combinate, purché ciascuna venga visualizzata al massimo una volta e tutte le unità visualizzate siano elencate in ordine decrescente di scala. Ad esempio, h
potrebbe essere visualizzato solo prima del giorno m
e solo dopo il giorno d
. Come esempio specifico, "1d2h3m4s5ms" sarebbe un valore di tempo valido, così come "4" o "4ms". Tutti gli spazi vuoti incorporati vengono eliminati.
Ritorni | |
---|---|
boolean |
obbligatorio
public boolean mandatory ()
Indica se l'opzione è obbligatoria o facoltativa.
Il framework di configurazione genera un ConfigurationException
se una delle seguenti condizioni è vera per un campo obbligatorio dopo l'analisi delle opzioni da tutte le origini:
- Il campo è
null
. - Il campo è un
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 caratteri "-".
Ad esempio, un Option
con il nome "help" viene specificato con "--help" sulla riga di comando.
I nomi non possono contenere i due punti, ad es. ":".
Ritorni | |
---|---|
String |
requiredForRerun
public boolean requiredForRerun ()
Indica se l'opzione è necessaria per compilare le istruzioni ed eseguire nuovamente un test.
Il report dei risultati potrebbe tentare di compilare le istruzioni su come ripetere un test e includere il messaggio nel risultato. L'istruzione deve includere tutte le opzioni applicabili a una ripetizione del test. Questo attributo viene utilizzato per indicare se l'opzione deve essere inclusa in questa istruzione.
Ritorni | |
---|---|
boolean |
shortName
public char shortName ()
Nome abbreviato facoltativo per l'opzione. Verrà mappato a un argomento della riga di comando preceduto da un singolo "-". ad es. "-h", dove h = shortName. Il valore "0" è riservato per indicare che l'opzione non ha shortName.
Ritorni | |
---|---|
char |
updateRule
public OptionUpdateRule updateRule ()
Consente di controllare il comportamento quando un'opzione viene specificata più volte. Tieni presente che questa regola viene ignorata completamente per le opzioni ERROR(/Collection)
o ERROR(/Map)
.
Ritorni | |
---|---|
OptionUpdateRule |