ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

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

Le stringhe nell'array String[] vengono analizzate da sinistra a destra. Ogni stringa viene classificata come opzione breve (ad esempio "-v"), opzione lunga (ad esempio "--verbose"), argomento di un'opzione (ad esempio "out.txt" in "-f out.txt") o argomento posizionale non opzionale.

Ogni argomento di opzione deve essere mappato a uno o più campi Option. Un'opzione lunga corrisponde al nome Option e un'opzione breve corrisponde al nome breve Option. Ogni nome di opzione e nome breve dell'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 in più oggetti. Gli argomenti Option possono essere inclusi 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 dell'oggetto o il valore dell'alias OptionClass separato da ":". Ad esempio:

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

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

È possibile specificare più opzioni brevi dopo un singolo "-" a condizione che 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 scritta direttamente dopo il nome dell'opzione, separata da "=", o come argomento successivo. ovvero "--file=out.txt" o "--file out.txt".

Un'opzione lunga booleana "--name" riceve automaticamente un'opzione complementare "--no-name". Data un'opzione "--flag", allora "--flag", "--no-flag", "--flag=true" e "--flag=false" sono tutti validi, anche se non sono consentiti "--flag true" né "--flag false" (poiché "--flag" è sufficiente, il successivo "true" o "false" viene interpretato separatamente). Puoi utilizzare "yes" e "no" come sinonimi di "true" e "false".

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

I campi corrispondenti alle opzioni vengono aggiornati man mano che le opzioni vengono elaborate. Gli eventuali 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 del manuale di getopt(1)
• Modulo "optparse" di Python (http://docs.python.org/library/optparse.html)
• le "Utility Syntax Guidelines" POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• gli "Standard per le interfacce a riga di comando" di GNU (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Riepilogo

Costruttori pubblici

public ArgsOptionParser (Object... optionSources)

public ArgsOptionParser (Collection<Object> optionSources)

Metodi pubblici

public Set<String> getInopOptions ()

public static String getOptionHelp (boolean importantOnly, 
                Object optionObject)

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

public List<String> parse (List<String> args)

public List<String> parse (String... args)

public List<String> parseBestEffort (List<String> args)

public List<String> parseBestEffort (List<String> args, 
                boolean forceContinue)

public List<String> parseBestEffort (String... args)

public void validateMandatoryOptions ()