ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

根据已解析的命令行参数填充“ Option字段。

传入的String []中的字符串从左到右进行解析。每个字符串都分为短选项（例如“ -v”），长选项（例如“ --verbose”），选项的参数（例如“ -f out.txt”中的“ out.txt”）。 ”）或非选项位置参数。

每个选项参数必须映射到一个或多个Option字段。长选项映射到Option名称，而短选项映射到Option简称。每个选项名称和选项短名称对于同一对象内的所有其他Option字段必须唯一。

一个选项参数可以映射到多个对象中具有相同名称的多个Option字段。可以对Option参数进行命名空间命名，以使用该对象的完整类名或由'：'分隔的OptionClass别名值来唯一引用单个对象中的Option字段。即

 --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”将被分别解释）。您可以将“是”和“否”用作“ true”和“ false”的同义词。

每个不以“-”开头且不是前一个选项的必需参数的String都是非选项位置参数，所有后续的String都是这样。 “-”之后的每个String都是非选项位置参数。

与选项相对应的字段在处理选项时会更新。所有剩余的位置参数都作为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 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 ()