ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

解析されたコマンドライン引数から Option フィールドにデータを入力します。

渡された String[] 内の文字列は、左から右に解析されます。各文字列は短い文字列として オプション（例: -v）、長いオプション（例: --verbose）、オプションへの引数（例: 「out.txt」"-f out.txt" 内）、またはオプションのない位置引数を指定します。

各オプション引数は、1 つ以上の Option フィールドにマッピングする必要があります。長いオプションは、トレーニング データ Option の名前。短いオプションは Option の略称にマッピングされます。各オプションの名前と オプションの略称は、他のすべてのオプションに対して一意である必要があります。 同じオブジェクト内の Option フィールド。

1 つのオプション引数を、同じ名前の複数の Option フィールドにマッピングできる 複数のオブジェクトにまたがります。Option 引数は、名前空間を指定して一意に参照できます。 Option フィールドは、そのオブジェクトのフルクラス名または 「:」で区切られた OptionClass エイリアス値。例:

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

簡単な省略形は「-」その後に短いオプション文字が続きます。オプションに 引数（ブール値以外のオプションにも当てはまります）は、独立したパラメータとして記述できます。 必要ありません。つまり、「-f out.txt」です。「-fout.txt」どちらも許容されます。

1 つの「-」の後に複数の短縮オプションを指定できます。すべて（例外は （最後の引数など）に引数は必要ありません。

長いオプションは「--」で始まるその後に何文字かが続きます。オプションに オプション名の直後または「=」で区切って記述することも、 渡します。（つまり、「--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」に設定します。

「-」で始まらない各文字列前のオプションの必須引数ではない場合、 すべて連続した 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) {
        ...
     }
     ...

 }

 

</ph>
• getopt(1) のマニュアル ページ
• Python の「optparse」モジュール（http://docs.python.org/library/optparse.html）
• POSIX「Utility Syntax Guidelines」 （http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02）
• GNU「Standards for Command Line Interfaces」 （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 ()