Opzione

NO_SHORT_NAME

public static final char NO_SHORT_NAME

Valore costante: 48 (0x00000030)

descrizione

public String description ()

Descrizione intuitiva dell'opzione.

importanza

public Option.Importance importance ()

L'importanza dell'opzione.

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

isTimeVal

public boolean isTimeVal ()

Indica se l'opzione rappresenta un valore temporale.

Se si tratta di un valore di ora, verranno analizzati i suffissi specifici dell'ora. Il campo DOVERE essere un long o Long affinché questo flag sia valido. In caso contrario, verrà generata un'eccezione 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, per 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 bianchi incorporati vengono eliminati.

obbligatorio

public boolean mandatory ()

Se l'opzione è obbligatoria o facoltativa.

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

• Il campo è null .
• Il campo è un ERROR(/Collection) vuoto.

nome

public String name ()

Il nome univoco obbligatorio per questa opzione.

Questo verrà associato a un argomento della riga di comando preceduto da due caratteri '-'. Ad esempio, Option con nome 'help' verrebbe specificata con '--help' sulla riga di comando.

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

requiredForRerun

public boolean requiredForRerun ()

Se l'opzione è necessaria per compilare l'istruzione per eseguire nuovamente un test.

Il reporter dei risultati può provare a compilare istruzioni su come eseguire nuovamente 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 tale istruzione.

nome corto

public char shortName ()

Nome abbreviato facoltativo per opzione. Questo verrà associato a un argomento della riga di comando preceduto da un singolo '-'. es. "-h" dove h = shortName. '0' è riservato per indicare che l'opzione non ha shortName.

updateRule

public OptionUpdateRule updateRule ()

Controlla il comportamento quando un'opzione viene specificata più volte. Si noti che questa regola viene ignorata completamente per le opzioni che sono ERROR(/Collection) s o ERROR(/Map) s.