参数选项解析器

public class ArgsOptionParser
extends OptionSetter

从解析的命令行参数填充Option字段。

传入的 String[] 中的字符串从左到右解析。每个String被分类为一个短选项（如“-v”），一个长选项（如“--verbose”），一个选项的参数（如“-f out.txt”中的“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 ()