ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Popola i campi Option dagli argomenti della riga di comando analizzati.

Le stringhe nella String[] passata vengono analizzate da sinistra a destra. Ogni stringa è classificata come un'opzione breve (come "-v"), un'opzione lunga (come "--verbose"), un argomento per un'opzione (come "out.txt" in "-f out.txt "), o un argomento posizionale non opzionale.

Ogni argomento di opzione deve essere associato a uno o più campi Option . Un'opzione lunga viene mappata al nome Option e un'opzione breve viene mappata al nome breve Option . Ciascun nome opzione e nome breve opzione deve essere univoco rispetto a tutti gli altri campi Option all'interno dello stesso oggetto.

Un singolo argomento di opzione può essere mappato a più campi Option con lo stesso nome su più oggetti. Gli argomenti Option possono essere inseriti in uno spazio dei nomi per fare riferimento in modo univoco a un campo Option all'interno di un singolo oggetto utilizzando il nome completo della classe di quell'oggetto o il suo valore alias OptionClass separato da ':'. cioè

 --classname:optionname optionvalue or
 --optionclassalias:optionname optionvalue.
 

Una semplice opzione breve è un "-" seguito da un carattere di opzione breve. Se l'opzione richiede un argomento (che è vero per qualsiasi opzione non booleana), può essere scritto come parametro separato, ma non è necessario. Cioè, "-f out.txt" e "-fout.txt" sono entrambi accettabili.

È possibile specificare più opzioni brevi dopo un singolo "-" purché tutte (tranne forse l'ultima) non richiedano argomenti.

Un'opzione lunga inizia con "--" seguito da diversi caratteri. Se l'opzione richiede un argomento, può essere scritto direttamente dopo il nome dell'opzione, separato da "=", o come argomento successivo. (Cioè, "--file=out.txt" o "--file out.txt".)

Un'opzione lunga booleana '--name' ottiene automaticamente un compagno '--no-name'. Data un'opzione "--flag", allora "--flag", "--no-flag", "--flag=true" e "--flag=false" sono tutti validi, sebbene nessuno dei due "--flag true" né "--flag false" sono consentiti (poiché "--flag" di per sé è sufficiente, il seguente "true" o "false" è interpretato separatamente). Puoi usare "sì" e "no" come sinonimi di "vero" e "falso".

Ogni stringa che non inizia con un "-" e non è un argomento obbligatorio di un'opzione precedente è un argomento posizionale non opzionale, come lo sono tutte le stringhe successive. Ogni stringa dopo un "--" è un argomento posizionale non opzionale.

I campi corrispondenti alle opzioni vengono aggiornati man mano che le relative opzioni vengono elaborate. Tutti gli argomenti posizionali rimanenti vengono restituiti come List<String>.

Ecco un semplice esempio:

 // Non-@Option fields will be ignored.
 class Options {
     @Option(name = "quiet", shortName = 'q')
     boolean quiet = false;

     // Here the user can use --no-color.
     @Option(name = "color")
     boolean color = true;

     @Option(name = "mode", shortName = 'm')
     String mode = "standard; // Supply a default just by setting the field.

     @Option(name = "port", shortName = 'p')
     int portNumber = 8888;

     // There's no need to offer a short name for rarely-used options.
     @Option(name = "timeout" )
     double timeout = 1.0;

     @Option(name = "output-file", shortName = 'o' })
     File output;

     // Multiple options are added to the collection.
     // The collection field itself must be non-null.
     @Option(name = "input-file", shortName = 'i')
     List<File> inputs = new ArrayList<File>();

 }

 Options options = new Options();
 List<String> posArgs = new OptionParser(options).parse("--input-file", "/tmp/file1.txt");
 for (File inputFile : options.inputs) {
     if (!options.quiet) {
        ...
     }
     ...

 }

 

• la pagina man di getopt(1).
• Modulo "optparse" di Python (http://docs.python.org/library/optparse.html)
• le "Linee guida sulla sintassi dell'utilità" POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• gli "Standards for Command Line Interfaces" GNU (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Riepilogo

Costruttori pubblici

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Metodi pubblici

public  getInopOptions ()

public static String getOptionHelp (boolean importantOnly, 
                Object optionObject)

   [-option_shortname, --option_name]          [option_description] Default:
   [current option field's value in optionObject]
 

public  parse (String... args)

public  parse ( args)

public  parseBestEffort ( args)

public  parseBestEffort ( args, 
                boolean forceContinue)

public  parseBestEffort (String... args)

public void validateMandatoryOptions ()