Skip to main content

Return to Answer

Added output
Source Link
Peter DeGregorio
Peter DeGregorio
  • 1.8k
  • 1
  • 11
  • 5
import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.CommandLineParser; import org.apache.commons.cli.DefaultParser; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; public static void main(String[] parameters) { CommandLine commandLine; Option option_A = Option.builder("A").argName("opt3").hasArg().desc("The A option").build(); Option option_r = Option.builder("r").argName("opt1").hasArg().desc("The r option").build(); Option option_S = Option.builder("S").argName("opt2").hasArg().desc("The S option").build(); Option option_test = Option.builder().longOpt("test").desc("The test option").build(); Options options = new Options(); CommandLineParser parser = new DefaultParser(); options.addOption(option_A); options.addOption(option_r); options.addOption(option_S); options.addOption(option_test); String header = " [<arg1> [<arg2> [<arg3> ...\n Options, flags and arguments may be in any order"; String footer = "This is DwB's solution brought to Commons CLI 1.3.1 compliance (deprecated methods replaced)"; HelpFormatter formatter = new HelpFormatter(); formatter.printHelp("CLItest""CLIsample", header, options, footer, true); String[] testArgs = { "-r", "opt1", "-S", "opt2", "arg1", "arg2", "arg3", "arg4", "--test", "-A", "opt3", "arg5", }; try { commandLine = parser.parse(options, testArgs); if (commandLine.hasOption("A")) { System.out.print("Option A is present. The value is: "); System.out.println(commandLine.getOptionValue("A")); } if (commandLine.hasOption("r")) { System.out.print("Option r is present. The value is: "); System.out.println(commandLine.getOptionValue("r")); } if (commandLine.hasOption("S")) { System.out.print("Option S is present. The value is: "); System.out.println(commandLine.getOptionValue("S")); } if (commandLine.hasOption("test")) { System.out.println("Option test is present. This is a flag option."); } { String[] remainder = commandLine.getArgs(); System.out.print("Remaining arguments: "); for (String argument : remainder) { System.out.print(argument); System.out.print(" "); } System.out.println(); } } catch (ParseException exception) { System.out.print("Parse error: "); System.out.println(exception.getMessage()); } }

Output:

usage: CLIsample [-A <opt3>] [-r <opt1>] [-S <opt2>] [--test] [<arg1> [<arg2> [<arg3> ... Options, flags and arguments may be in any order -A <opt3> The A option -r <opt1> The r option -S <opt2> The S option --test The test option This is DwB's solution brought to Commons CLI 1.3.1 compliance (deprecated methods replaced) Option A is present. The value is: opt3 Option r is present. The value is: opt1 Option S is present. The value is: opt2 Option test is present. This is a flag option. Remaining arguments: arg1 arg2 arg3 arg4 
import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.CommandLineParser; import org.apache.commons.cli.DefaultParser; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; public static void main(String[] parameters) { CommandLine commandLine; Option option_A = Option.builder("A").argName("opt3").hasArg().desc("The A option").build(); Option option_r = Option.builder("r").argName("opt1").hasArg().desc("The r option").build(); Option option_S = Option.builder("S").argName("opt2").hasArg().desc("The S option").build(); Option option_test = Option.builder().longOpt("test").desc("The test option").build(); Options options = new Options(); CommandLineParser parser = new DefaultParser(); options.addOption(option_A); options.addOption(option_r); options.addOption(option_S); options.addOption(option_test); String header = " [<arg1> [<arg2> [<arg3> ...\n Options, flags and arguments may be in any order"; String footer = "This is DwB's solution brought to Commons CLI 1.3.1 compliance (deprecated methods replaced)"; HelpFormatter formatter = new HelpFormatter(); formatter.printHelp("CLItest", header, options, footer, true); String[] testArgs = { "-r", "opt1", "-S", "opt2", "arg1", "arg2", "arg3", "arg4", "--test", "-A", "opt3", "arg5", }; try { commandLine = parser.parse(options, testArgs); if (commandLine.hasOption("A")) { System.out.print("Option A is present. The value is: "); System.out.println(commandLine.getOptionValue("A")); } if (commandLine.hasOption("r")) { System.out.print("Option r is present. The value is: "); System.out.println(commandLine.getOptionValue("r")); } if (commandLine.hasOption("S")) { System.out.print("Option S is present. The value is: "); System.out.println(commandLine.getOptionValue("S")); } if (commandLine.hasOption("test")) { System.out.println("Option test is present. This is a flag option."); } { String[] remainder = commandLine.getArgs(); System.out.print("Remaining arguments: "); for (String argument : remainder) { System.out.print(argument); System.out.print(" "); } System.out.println(); } } catch (ParseException exception) { System.out.print("Parse error: "); System.out.println(exception.getMessage()); } } 
import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.CommandLineParser; import org.apache.commons.cli.DefaultParser; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; public static void main(String[] parameters) { CommandLine commandLine; Option option_A = Option.builder("A").argName("opt3").hasArg().desc("The A option").build(); Option option_r = Option.builder("r").argName("opt1").hasArg().desc("The r option").build(); Option option_S = Option.builder("S").argName("opt2").hasArg().desc("The S option").build(); Option option_test = Option.builder().longOpt("test").desc("The test option").build(); Options options = new Options(); CommandLineParser parser = new DefaultParser(); options.addOption(option_A); options.addOption(option_r); options.addOption(option_S); options.addOption(option_test); String header = " [<arg1> [<arg2> [<arg3> ...\n Options, flags and arguments may be in any order"; String footer = "This is DwB's solution brought to Commons CLI 1.3.1 compliance (deprecated methods replaced)"; HelpFormatter formatter = new HelpFormatter(); formatter.printHelp("CLIsample", header, options, footer, true); String[] testArgs = { "-r", "opt1", "-S", "opt2", "arg1", "arg2", "arg3", "arg4", "--test", "-A", "opt3", }; try { commandLine = parser.parse(options, testArgs); if (commandLine.hasOption("A")) { System.out.print("Option A is present. The value is: "); System.out.println(commandLine.getOptionValue("A")); } if (commandLine.hasOption("r")) { System.out.print("Option r is present. The value is: "); System.out.println(commandLine.getOptionValue("r")); } if (commandLine.hasOption("S")) { System.out.print("Option S is present. The value is: "); System.out.println(commandLine.getOptionValue("S")); } if (commandLine.hasOption("test")) { System.out.println("Option test is present. This is a flag option."); } { String[] remainder = commandLine.getArgs(); System.out.print("Remaining arguments: "); for (String argument : remainder) { System.out.print(argument); System.out.print(" "); } System.out.println(); } } catch (ParseException exception) { System.out.print("Parse error: "); System.out.println(exception.getMessage()); } }

Output:

usage: CLIsample [-A <opt3>] [-r <opt1>] [-S <opt2>] [--test] [<arg1> [<arg2> [<arg3> ... Options, flags and arguments may be in any order -A <opt3> The A option -r <opt1> The r option -S <opt2> The S option --test The test option This is DwB's solution brought to Commons CLI 1.3.1 compliance (deprecated methods replaced) Option A is present. The value is: opt3 Option r is present. The value is: opt1 Option S is present. The value is: opt2 Option test is present. This is a flag option. Remaining arguments: arg1 arg2 arg3 arg4
Source Link
Peter DeGregorio
Peter DeGregorio
  • 1.8k
  • 1
  • 11
  • 5

Here is @DwB solution upgraded to Commons CLI 1.3.1 compliance (replaced deprecated components OptionBuilder and GnuParser). The Apache documentation uses examples that in real life have unmarked/bare arguments but ignores them. Thanks @DwB for showing how it works.

import org.apache.commons.cli.CommandLine; import org.apache.commons.cli.CommandLineParser; import org.apache.commons.cli.DefaultParser; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.cli.ParseException; public static void main(String[] parameters) { CommandLine commandLine; Option option_A = Option.builder("A").argName("opt3").hasArg().desc("The A option").build(); Option option_r = Option.builder("r").argName("opt1").hasArg().desc("The r option").build(); Option option_S = Option.builder("S").argName("opt2").hasArg().desc("The S option").build(); Option option_test = Option.builder().longOpt("test").desc("The test option").build(); Options options = new Options(); CommandLineParser parser = new DefaultParser(); options.addOption(option_A); options.addOption(option_r); options.addOption(option_S); options.addOption(option_test); String header = " [<arg1> [<arg2> [<arg3> ...\n Options, flags and arguments may be in any order"; String footer = "This is DwB's solution brought to Commons CLI 1.3.1 compliance (deprecated methods replaced)"; HelpFormatter formatter = new HelpFormatter(); formatter.printHelp("CLItest", header, options, footer, true); String[] testArgs = { "-r", "opt1", "-S", "opt2", "arg1", "arg2", "arg3", "arg4", "--test", "-A", "opt3", "arg5", }; try { commandLine = parser.parse(options, testArgs); if (commandLine.hasOption("A")) { System.out.print("Option A is present. The value is: "); System.out.println(commandLine.getOptionValue("A")); } if (commandLine.hasOption("r")) { System.out.print("Option r is present. The value is: "); System.out.println(commandLine.getOptionValue("r")); } if (commandLine.hasOption("S")) { System.out.print("Option S is present. The value is: "); System.out.println(commandLine.getOptionValue("S")); } if (commandLine.hasOption("test")) { System.out.println("Option test is present. This is a flag option."); } { String[] remainder = commandLine.getArgs(); System.out.print("Remaining arguments: "); for (String argument : remainder) { System.out.print(argument); System.out.print(" "); } System.out.println(); } } catch (ParseException exception) { System.out.print("Parse error: "); System.out.println(exception.getMessage()); } }