Commons-cli-overview

Apache Commons CLI-概要

Apache Commons CLIは、Java APIから派生したApache Commonsのコンポーネントであり、プログラムに渡されたコマンドライン引数/オプションを解析するAPIを提供します。 このAPIは、利用可能なオプションに関連するヘルプを印刷することもできます。

コマンドライン処理は3つのステージで構成されます。

• 定義ステージ
• 解析段階
• 尋問段階

定義ステージ

定義段階では、アプリケーションが使用できるオプションを定義し、それに応じて動作します。 Commons CLIは、OptionオブジェクトのコンテナであるOptionsクラスを提供します。

//create Options object
Options options = new Options();

//add a option
options.addOption("a", false, "add two numbers");

ここでオプションフラグaを追加しました。2番目のパラメーターとしてのfalseはオプションが必須ではないことを示し、3番目のパラメーターはオプションの説明を示します。

解析段階

解析段階では、パーサーインスタンスを作成した後、コマンドライン引数を使用して渡されたオプションを解析します。

//Create a parser
CommandLineParser parser = new DefaultParser();

//parse the options passed as command line arguments
CommandLine cmd = parser.parse( options, args);

尋問段階

尋問段階では、特定のオプションが存在するかどうかを確認し、それに応じてコマンドを処理します。

//hasOptions checks if option is present or not
if(cmd.hasOption("a")) {
  //add the two numbers
} else if(cmd.hasOption("m")) {
  //multiply the two numbers
}