Opzione

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


Annota un campo come rappresentante un'opzione IConfiguration.

Riepilogo

Costanti

char NO_SHORT_NAME

Metodi pubblici

String description()

Descrizione dell'opzione di facile utilizzo.

Option.Importance importance()

L'importanza dell'opzione.

boolean isTimeVal()

Indica se l'opzione rappresenta un valore di tempo.

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 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

description

public String description ()

Descrizione dell'opzione di facile utilizzo.

Resi
String

importance

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 della guida completo.

Resi
Option.Importance

isTimeVal

public boolean isTimeVal ()

Indica se l'opzione rappresenta un valore di tempo.

Se si tratta di un valore di tempo, verranno analizzati i suffissi specifici del tempo. Il campo DEVE essere un long o Long affinché questo flag sia valido. In caso contrario, verrà generata una ConfigurationException.

L'unità predefinita è 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é ogni unità appaia al massimo una volta e purché tutte le unità che appaiono siano elencate in ordine decrescente di scala. Ad esempio, h può apparire solo prima di m e solo dopo d. Ad esempio specifico, "1d2h3m4s5ms" sarebbe un valore di tempo valido, così come "4" o "4ms". Tutti gli spazi vuoti incorporati vengono ignorati.

Resi
boolean

mandatory

public boolean mandatory ()

Indica se l'opzione è obbligatoria o facoltativa.

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

  • Il campo è null.
  • Il campo è una Collection vuota.

Resi
boolean

name

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, un Option con il nome "help" verrebbe specificato con "--help" nella riga di comando.

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

Resi
String

requiredForRerun

public boolean requiredForRerun ()

Indica se l'opzione è necessaria per compilare le istruzioni per eseguire di nuovo un test.

Il reporter dei risultati può provare a compilare le istruzioni su come eseguire di nuovo un test e includere il messaggio nel risultato. Le istruzioni devono includere tutte le opzioni applicabili a una nuova esecuzione del test. Questo attributo viene utilizzato per indicare se l'opzione deve essere inclusa in queste istruzioni.

Resi
boolean

shortName

public char shortName ()

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

Resi
char

updateRule

public OptionUpdateRule updateRule ()

Controlla il comportamento quando un'opzione viene specificata più volte. Tieni presente che questa regola viene completamente ignorata per le opzioni che sono Collections o Maps.

Resi
OptionUpdateRule