ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Wypełnia pola Option na podstawie przeanalizowanych argumentów wiersza poleceń.

Ciągi znaków w przekazanym tablicy String[] są analizowane od lewej do prawej. Każdy ciąg jest klasyfikowany jako krótka opcja (np. „-v”), długa opcja (np. „--verbose”), argument opcji (np. „out.txt” w „-f out.txt”) lub argument pozycyjny inny niż opcja.

Każdy argument opcji musi być zmapowany na co najmniej 1 pole Option. Długa opcja jest mapowana na nazwę Option, a krótka – na nazwę Option. Każda nazwa opcji i krótka nazwa opcji muszą być unikalne w stosunku do wszystkich innych pól Option w tym samym obiekcie.

Pojedynczy argument opcji może być mapowany na wiele pól Option o tej samej nazwie w różnych obiektach. Parametry Option mogą być powiązane z przestrzenią nazw, aby jednoznacznie wskazywać pole Option w pojedynczym obiekcie za pomocą pełnej nazwy klasy tego obiektu lub wartości aliasu OptionClass oddzielonej dwukropkiem (:). Przykład:

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

Prosta krótka opcja to „-” z dodatkiem znaku opcji. Jeśli opcja wymaga argumentu (co dotyczy każdej opcji niebędącej typu boolean), może być zapisana jako osobny parametr, ale nie musi. Oznacza to, że zarówno „-f out.txt”, jak i „-fout.txt” są akceptowane.

Pojedynczym znakiem „-” można podać dowolną liczbę krótkich opcji, o ile wszystkie (z wyjątkiem opcji ostatniej) nie wymagają argumentów.

Długa opcja zaczyna się od ciągu „--”, po którym następuje kilka znaków. Jeśli opcja wymaga argumentu, może on być zapisany bezpośrednio po nazwie opcji, rozdzielony znakiem „=”, lub jako kolejny argument. (czyli „--file=out.txt” lub „--file out.txt”).

Długa opcja logiczna „––name” automatycznie dostaje towarzysza „––no-name”. Jeśli opcja to „--flag”, to „--flag”, „--no-flag”, „--flag=true” i „--flag=false” są prawidłowe, ale ani „--flag true”, ani „--flag false” nie są dozwolone (ponieważ „--flag” jest wystarczające, a następujące „true” lub „false” jest interpretowane osobno). Możesz użyć „tak” i „nie” jako synonimów „prawda” i „fałsz”.

Każdy ciąg znaków, który nie zaczyna się od „-” i nie jest wymaganym argumentem poprzedniej opcji, jest argumentem pozycyjnym niebędącym opcją, podobnie jak wszystkie kolejne ciągi znaków. Każdy ciąg znaków po „--” jest nieopcjonalnym argumentem pozycyjnym.

Pola odpowiadające opcjom są aktualizowane w miarę przetwarzania opcji. Pozostałe argumenty pozycyjne są zwracane jako lista<String>.

Oto prosty przykład:

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

 }

 

• strona man getopt(1);
• Moduł „optparse” w Pythonie (http://docs.python.org/library/optparse.html)
• „Wytyczne dotyczące składni narzędzi” w standardzie POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02).
• „Standardy interfejsów wiersza poleceń” GNU (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces).

Podsumowanie

Konstruktory publiczne

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Metody publiczne

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