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".)

Логический параметр типа long '--name' автоматически получает дополнение '--no-name'. Если задан параметр "--flag", то "--flag", "--no-flag", "--flag=true" и "--flag=false" являются допустимыми, хотя ни "--flag true", ни "--flag false" не допускаются (поскольку "--flag" сам по себе достаточен, последующие "true" или "false" интерпретируются отдельно). Вы можете использовать "yes" и "no" как синонимы для "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 (Object... optionSources)

public ArgsOptionParser (Collection<Object> optionSources)

Общедоступные методы

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