Opzione

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


Annota un campo come rappresentante di un'opzione IConfiguration .

Riepilogo

Costanti

char NO_SHORT_NAME

Metodi pubblici

String description ()

Descrizione intuitiva dell'opzione.

Option.Importance importance ()

L'importanza dell'opzione.

boolean isTimeVal ()

Indica se l'opzione rappresenta un valore temporale.

boolean mandatory ()

Se l'opzione è obbligatoria o facoltativa.

String name ()

Il nome univoco obbligatorio per questa opzione.

boolean requiredForRerun ()

Se l'opzione è necessaria per compilare istruzioni per rieseguire 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 intuitiva dell'opzione.

ritorna
String

importanza

public Option.Importance importance ()

L'importanza dell'opzione.

Un'opzione ritenuta "importante" verrà visualizzata nell'output abbreviato della guida. L'aiuto per un'opzione non importante verrà visualizzato solo nel testo completo della guida.

ritorna
Option.Importance

isTimeVal

public boolean isTimeVal ()

Indica se l'opzione rappresenta un valore temporale.

Se si tratta di un valore temporale, verranno analizzati i suffissi specifici del tempo. Il campo DOVERE essere long o Long affinché questo flag sia valido. Altrimenti verrà lanciata una ConfigurationException .

L'unità predefinita è millis. Il framework di configurazione accetterà s per secondi (1000 millis), m per minuti (60 secondi), h per ore (60 minuti) o d per giorni (24 ore).

Le unità possono essere mescolate e abbinate, purché ciascuna unità appaia al massimo una volta e purché tutte le unità che compaiono siano elencate in ordine di scala decrescente. Quindi, ad esempio, h può apparire solo prima m e può apparire solo dopo d . Come esempio specifico, "1d2h3m4s5ms" sarebbe un valore temporale valido, così come "4" o "4ms". Tutti gli spazi incorporati vengono eliminati.

ritorna
boolean

obbligatorio

public boolean mandatory ()

Se l'opzione è obbligatoria o facoltativa.

Il framework di configurazione lancerà una ConfigurationException se una delle seguenti condizioni è vera per un campo obbligatorio dopo che le opzioni sono state analizzate da tutte le origini:

ritorna
boolean

nome

public String name ()

Il nome univoco obbligatorio per questa opzione.

Questo verrà mappato a un argomento della riga di comando con il prefisso di due caratteri '-'. Ad esempio, Option con nome "help" verrebbe specificata con "--help" sulla riga di comando.

I nomi non possono contenere due punti, ad esempio ":".

ritorna
String

richiestoPerRieseguire

public boolean requiredForRerun ()

Se l'opzione è necessaria per compilare istruzioni per rieseguire un test.

Il segnalatore dei risultati può provare a compilare istruzioni su come eseguire nuovamente un test e includere il messaggio nel risultato. Le istruzioni devono includere tutte le opzioni applicabili alla ripetizione della prova. Questo attributo viene utilizzato per indicare se l'opzione deve essere inclusa in tale istruzione.

ritorna
boolean

nome corto

public char shortName ()

Nome abbreviato facoltativo per l'opzione. Questo verrà mappato a un argomento della riga di comando con il prefisso "-". ad esempio "-h" dove h = shortName. '0' è riservato per indicare che l'opzione non ha shortName.

ritorna
char

updateRule

public OptionUpdateRule updateRule ()

Controlla 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) .

ritorna
OptionUpdateRule