ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Заполняет поля Option из проанализированных аргументов командной строки.

Строки в переданном String[] анализируются слева направо. Каждая строка классифицируется как короткая опция (например, "-v"), длинная опция (например, "--verbose"), аргумент опции (например, "out.txt" в "-f out.txt"). ") или необязательный позиционный аргумент.

Каждый аргумент параметра должен сопоставляться с одним или несколькими полями Option . Длинная опция сопоставляется с именем Option , а короткая опция сопоставляется с коротким именем Option . Каждое имя параметра и краткое имя параметра должны быть уникальными по отношению ко всем другим полям Option в том же объекте.

Один аргумент параметра может быть сопоставлен с несколькими полями Option с одинаковым именем в нескольких объектах. Аргументы Option могут быть объединены в пространство имен, чтобы однозначно ссылаться на поле Option внутри одного объекта, используя полное имя класса этого объекта или значение его псевдонима OptionClass , разделенные символом ':'. т.е.

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

Простая короткая опция — это «-», за которым следует символ короткой опции. Если опция требует аргумента (что верно для любой нелогической опции), она может быть записана как отдельный параметр, но не обязательно. То есть допустимы как "-f out.txt", так и "-fout.txt".

Можно указать несколько коротких опций после одного «-», если все (кроме, возможно, последнего) не требуют аргументов.

Длинный вариант начинается с «--», за которым следуют несколько символов. Если параметру требуется аргумент, он может быть указан непосредственно после имени параметра, разделенный символом «=», или в качестве следующего аргумента. (То есть "--file=out.txt" или "--file out.txt".)

Логическая длинная опция «--name» автоматически получает компаньон «--no-name». При заданной опции "--flag" допустимы "--flag", "--no-flag", "--flag=true" и "--flag=false", хотя ни один из них "--flag true" и "--flag false" не допускаются (поскольку "--flag" достаточно, последующие "true" или "false" интерпретируются отдельно). Вы можете использовать «да» и «нет» как синонимы «истинно» и «ложно».

Каждая строка, не начинающаяся с "-" и не являющаяся обязательным аргументом предыдущей опции, является неопциональным позиционным аргументом, как и все последующие строки. Каждая строка после "--" является необязательным позиционным аргументом.

Поля, соответствующие параметрам, обновляются по мере обработки их параметров. Любые оставшиеся позиционные аргументы возвращаются в виде List<String>.

Вот простой пример:

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

 }

 

• справочная страница getopt(1)
• Модуль Python «optparse» (http://docs.python.org/library/optparse.html)
• POSIX «Руководство по синтаксису утилит» (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• «Стандарты GNU для интерфейсов командной строки» (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Краткое содержание

Публичные конструкторы

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Публичные методы

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