ArgsOptionParser (AgsOptionParser)

public class ArgsOptionParser
extends OptionSetter

從剖析的指令列引數中填入 Option 欄位。

傳入的 String[] 中的字串是由左至右剖析。每個字串都會歸類為簡短 選項 (例如「-v」)、長選項 (例如「--verbose」) )、選項引數 (例如 「out.txt」，或是非選項的位置引數，

每個選項引數都必須對應至一或多個 Option 欄位。長選項會對應至 Option 名稱和一個簡短選項對應至 Option 簡稱。每個選項名稱和 選項簡稱必須與所有其他項目 相同物件內的 Option 欄位。

單一選項引數可對應至多個名稱相同的 Option 欄位 以便在多個物件之間運作Option 引數可做為命名空間來代表 單一物件內的 Option 欄位，會使用該物件的完整類別名稱或 OptionClass別名值 (以「:」分隔)。ie

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

簡單來說就是「-」後面接著簡短的選項字元如果這個選項需要 引數 (任何非布林值選項的 true) 可視為獨立參數。 但不一定也就是「-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」

每個開頭不是以「-」開頭的字串並非前一個選項的必要引數 非選項位置引數，就像所有連續字串一樣。「--」後方的每個字串是 非選項位置引數

與選項相對應的欄位會在選項處理時更新。剩餘 位置引數會以 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 ()