ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

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

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

Każdy argument opcji musi być mapowany na co najmniej jedno pole Option . Długa opcja jest odwzorowywana na nazwę Option , a krótka opcja jest odwzorowywana na krótką nazwę Option . Każda nazwa opcji i nazwa skrócona opcji muszą być unikalne w odniesieniu do wszystkich innych pól Option w tym samym obiekcie.

Pojedynczy argument opcji może zostać zamapowany na wiele pól Option o tej samej nazwie w wielu obiektach. Argumenty Option mogą być umieszczane w przestrzeni nazw, aby jednoznacznie odwoływać się do pola Option w pojedynczym obiekcie przy użyciu pełnej nazwy klasy tego obiektu lub jego wartości aliasu OptionClass oddzielonej znakiem ':'. tj

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

Prostą krótką opcją jest „-”, po której następuje krótki znak opcji. Jeśli opcja wymaga argumentu (co jest prawdziwe w przypadku każdej opcji innej niż logiczna), może być zapisana jako oddzielny parametr, ale nie musi tak być. Oznacza to, że akceptowalne są "-f out.txt" i "-fout.txt".

Możliwe jest określenie wielu krótkich opcji po jednym „-”, o ile wszystkie (z wyjątkiem być może ostatniej) nie wymagają argumentów.

Długa opcja zaczyna się od „--”, po którym następuje kilka znaków. Jeśli opcja wymaga argumentu, może być napisana bezpośrednio po nazwie opcji, oddzielona znakiem „=” lub jako następny argument. (To znaczy „--file=out.txt” lub „--file out.txt”).

Długa opcja logiczna '--name' automatycznie otrzymuje towarzysza '--no-name'. Biorąc pod uwagę opcję „--flag”, wówczas „--flag”, „--no-flag”, „--flag=true” i „--flag=false” są poprawne, ale żaden z „--flag” prawda” ani „--flag fałsz” są dozwolone (ponieważ samo „--flag” jest wystarczające, następujące „prawda” lub „fałsz” są interpretowane oddzielnie). Możesz użyć „tak” i „nie” jako synonimów „prawda” i „fałsz”.

Każdy String, który nie zaczyna się od "-" i nie jest wymaganym argumentem poprzedniej opcji, jest argumentem pozycyjnym nie będącym opcją, tak jak wszystkie kolejne Stringi. Każdy ciąg znaków po „--” jest argumentem pozycyjnym nie będącym opcją.

Pola odpowiadające opcjom są aktualizowane w miarę przetwarzania ich opcji. Wszelkie pozostałe argumenty pozycyjne są zwracane jako List<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 podręcznika getopt(1)
• Moduł Pythona „optparse” (http://docs.python.org/library/optparse.html)
• POSIX „Wytyczne dotyczące składni narzędzi” (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)

Streszczenie

Konstruktorzy publiczni

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