ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Füllt Option-Felder aus geparsten Befehlszeilenargumenten.

Strings im übergebenen String[] werden von links nach rechts geparst. Jeder String wird als Kurzform klassifiziert, (z. B. "-v"), eine lange Option (z. B. "--verbose"), ein Argument für eine Option (z. B. „out.txt“ in „-f out.txt“) oder ein Positionsargument ohne Option sein.

Jedes Optionsargument muss einem oder mehreren Option-Feldern zugeordnet sein. Eine lange Option entspricht Option-Name und eine kurze Option wird dem Kurznamen Option zugeordnet. Jeder Optionsname und Der Kurzname der Option muss in Bezug auf alle anderen Option-Felder innerhalb desselben Objekts.

Ein einzelnes Optionsargument kann mehreren Option-Feldern mit demselben Namen zugeordnet werden für mehrere Objekte. Option-Argumente können mit einem Namespace versehen werden, um eindeutig auf ein Option innerhalb eines einzelnen Objekts unter Verwendung des vollständigen Klassennamens oder der OptionClass-Aliaswert, getrennt durch „:“. d

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

Eine einfache kurze Option ist „-“ gefolgt von einem kurzen Optionszeichen. Wenn für die Option ein -Argument (was auf jede nicht-boolesche Option zutrifft), kann es als separater Parameter geschrieben werden, aber nicht sein müssen. Das heißt, „-f out.txt“ und „-fout.txt“ sind beide akzeptabel.

Nach einem einzelnen „-“ können mehrere Kurzoptionen angegeben werden. solange alle (außer möglicherweise die letzte) erfordern keine Argumente.

Eine lange Option beginnt mit „--“ gefolgt von mehreren Zeichen. Wenn für die Option ein Argument direkt nach dem Optionsnamen, getrennt durch "=", oder als nächstes . (d. h. „--file=out.txt“ oder „--file out.txt“.)

Eine boolesche lange Option „--name“ erhält automatisch die Meldung "--no-name", Companion ist. Option angegeben "--flag", then, "--flag", "--no-flag", "--flag=true" und "--flag=false" sind jedoch alle gültig, weder "--flag true" noch „--flag false“ zulässig, da „--flag“ allein ausreicht, folgen „true“ oder „false“ separat interpretiert werden). Sie können „Ja“ verwenden. und „nein“ als Synonyme für „true“ und „false“.

Jeder String beginnt nicht mit einem „-“ und kein erforderliches Argument der vorherigen Option Positionsargument ohne Option wie alle aufeinanderfolgenden Strings. Jeder String nach einem „--“ ist ein Positionsargument ohne Option.

Die Felder, die den Optionen entsprechen, werden während der Verarbeitung ihrer Optionen aktualisiert. Noch übrig 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) {
        ...
     }
     ...

 }

 

</ph>
• getopt(1)-Manpage
• „optparse“ von Python Modul (http://docs.python.org/library/optparse.html)
• die POSIX-Richtlinien für die Syntax von Dienstprogrammen (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 ( optionSources)

public ArgsOptionParser (Object... optionSources)

Öffentliche Methoden

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