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」的同義字。

每個字串如果不是以「-」開頭，且不是先前選項的必要引數，就是非選項位置引數，後續的所有字串也是如此。「--」後面的每個字串都是非選項位置引數。

系統會在處理選項時更新對應的欄位。任何剩餘的位址引數都會以 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 ()