ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Füllt Option-Felder mit geparsten Befehlszeilenargumenten.

Strings im übergebenen String[] werden von links nach rechts geparst. Jeder String wird als kurze Option (z. B. „-v“), lange Option (z. B. „--verbose“), Argument für eine Option (z. B. „out.txt“ in „-f out.txt“) oder als nicht optionale Positionsparameter klassifiziert.

Jedes Optionsargument muss einem oder mehreren Option-Feldern zugeordnet werden. Eine lange Option wird dem Namen Option und eine kurze Option dem Kurznamen Option zugeordnet. Jeder Optionsname und jeder Optionskurzname muss in Bezug auf alle anderen Option-Felder innerhalb desselben Objekts eindeutig sein.

Ein einzelnes Optionsargument kann mehreren Option-Feldern mit demselben Namen in mehreren Objekten zugeordnet werden. Option-Argumente können mit einem Namespace versehen werden, um eindeutig auf ein Option-Feld innerhalb eines einzelnen Objekts zu verweisen. Dazu wird der vollständige Klassenname des Objekts oder sein OptionClass-Aliaswert verwendet, getrennt durch „:“, z. B.

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

Eine einfache Kurzoption besteht aus einem „-“, gefolgt von einem Zeichen für die Kurzoption. Wenn für die Option ein Argument erforderlich ist (was bei allen nicht booleschen Optionen der Fall ist), kann sie als separater Parameter geschrieben werden, muss es aber nicht. Sowohl „-f out.txt“ als auch „-fout.txt“ sind zulässig.

Es ist möglich, mehrere kurze Optionen nach einem einzelnen „-“ anzugeben, sofern alle (mit Ausnahme des letzten) keine Argumente erfordern.

Eine lange Option beginnt mit „--“, gefolgt von mehreren Zeichen. Wenn für die Option ein Argument erforderlich ist, kann es direkt nach dem Optionsnamen, getrennt durch „=“, oder als nächstes Argument angegeben werden. Das heißt, „--file=out.txt“ oder „--file out.txt“.

Für die boolesche Langoption „--name“ wird automatisch eine Option „--no-name“ erstellt. Bei der Option „--flag“ sind „--flag“, „--no-flag“, „--flag=true“ und „--flag=false“ alle gültig. „--flag true“ und „--flag false“ sind jedoch nicht zulässig, da „--flag“ allein ausreicht und das folgende „true“ oder „false“ separat interpretiert wird. Sie können „yes“ und „no“ als Synonyme für „true“ und „false“ verwenden.

Jeder String, der nicht mit „-“ beginnt und kein erforderliches Argument einer vorherigen Option ist, ist ein nicht optionales Positionsargument, ebenso wie alle nachfolgenden Strings. Jeder String nach „--“ ist ein nicht optionales Positionsargument.

Die Felder, die den Optionen entsprechen, werden aktualisiert, wenn die Optionen verarbeitet werden. Alle verbleibenden Positionsargumente werden als List<String> zurückgegeben.

Hier ein einfaches Beispiel:

 // 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) {
        ...
     }
     ...

 }

 

• die Manpage zu getopt(1)
• Das „optparse“-Modul von Python (http://docs.python.org/library/optparse.html)
• die POSIX-Richtlinien für die Utility-Syntax (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• die GNU-Standards für Befehlszeilenschnittstellen (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Zusammenfassung

Öffentliche Konstruktoren

public ArgsOptionParser (Object... optionSources)

public ArgsOptionParser (Collection<Object> optionSources)

Öffentliche Methoden

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