Analisi opzioni Args

public class ArgsOptionParser
extends OptionSetter

Compila i campi Option con gli argomenti della riga di comando analizzati.

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

Ogni argomento dell'opzione deve essere mappato a uno o più campi Option. Un'opzione lunga mappa Option e un'opzione breve mappa al nome breve di Option. Il nome di ogni opzione il nome breve dell'opzione deve essere univoco rispetto a tutte le altre Option campi all'interno dello stesso oggetto.

Un singolo argomento di opzione può essere mappato a più campi Option con lo stesso nome in più oggetti. Option argomenti possono avere uno spazio dei nomi per fare riferimento in modo univoco a un Option campo all'interno di un singolo oggetto utilizzando il nome completo della classe dell'oggetto o la relativa Valore alias OptionClass separato da ':'. ie

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

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

È possibile specificare più opzioni brevi dopo un singolo carattere "-" purché tutte (tranne probabilmente l'ultimo) non richiedono argomenti.

Un'opzione lunga inizia con "--" seguiti da diversi caratteri. Se l'opzione richiede un può essere scritto direttamente dopo il nome dell'opzione, separati da "=", o come . (ad esempio "--file=out.txt" o "--file out.txt").

Un'opzione lunga booleana "--name" ottiene automaticamente lo stato "--no-name" companion. Esiste un'opzione "--flag", quindi "--flag", "--no-flag", "--flag=true" e "--flag=false" sono tutte valide, né "--flag true" né "--flag false" sono consentiti (poiché "--flag" di per sé è sufficiente, che segue "true" o "false" viene interpretata separatamente). Puoi rispondere "sì" e "no" come sinonimi per "true" e "false".

Ogni stringa non inizia con un segno "-" e non un argomento richiesto di un'opzione precedente è un un argomento posizionale non-option, così come tutte le stringhe successive. Ogni stringa dopo "--" è un un argomento posizionale non-option.

I campi corrispondenti alle opzioni vengono aggiornati man mano che le rispettive opzioni vengono elaborate. Qualsiasi rimanente gli argomenti posizionali 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)
• "optparse" di Python (http://docs.python.org/library/optparse.html)
• le POSIX "Utility Syntax Guidelines" (Linee guida per la sintassi di utilità) (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• gli "Standards for Command Line Interfaces" della 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 ()