private static Options createHelpOptions() { final Options options = new Options(); options.addOption(Option.builder(HELP_KEY).longOpt("help") .desc("print this message").build()); return options; }
/** * Create command line option with only long name and only one argument. * * @param longOpt long version of option * @param argName name of argument for help message * @param desc description of option */ private Option createSingleArgOpt(String longOpt, String argName, String desc) { return Option.builder().longOpt(longOpt).hasArg().argName(argName).desc(desc).build(); }
/** * Create command line option with short name, long name, and only one argument. * * @param shortOpt short version of option * @param longOpt long version of option * @param argName name of argument for help message * @param desc description of option */ private Option createSingleArgOpt(String shortOpt, String longOpt, String argName, String desc) { return Option.builder(shortOpt).longOpt(longOpt).hasArg().argName(argName).desc(desc).build(); }
private OptionDefinition( final String shortOption, final String longOption, final boolean hasArgument, final String argumentNameDisplayed, final String description, final boolean printsHelp, final OptionBehavior behavior) { final Option.Builder builder; if (shortOption == null) { builder = Option.builder(); } else { builder = Option.builder(shortOption); } if (longOption != null) { builder.longOpt(longOption); } if (hasArgument) { builder.hasArg(true); builder.argName(argumentNameDisplayed); } if (description != null) { builder.desc(description); } this.cliOption = builder.build(); this.printsHelp = printsHelp; this.behavior = behavior; }
Options options = new Options(); options.addOption(Option.builder("a") .longOpt("anonymize") .desc("Strip out any possibly identifiable information") .build()); options.addOption(Option.builder("o") .longOpt("output-dir") .argName("<file>") .hasArg() .build()); options.addOption(Option.builder("h") .longOpt("help") .desc("Print a help message") .build());
checkOption(Option.builder("a").desc("desc").build(), "a", "desc", null, Option.UNINITIALIZED, null, false, false, defaultSeparator, String.class); checkOption(Option.builder("a").desc("desc").longOpt("aaa").build(), "a", "desc", "aaa", Option.UNINITIALIZED, null, false, false, defaultSeparator, String.class); checkOption(Option.builder("a").desc("desc").hasArg(true).build(),
Options options = new Options(); options.addOption(Option.builder("h") .longOpt("help") .desc("Print a help message") .build());
private Options getOptions() { Options options = new Options(); Option help = Option.builder("h") .longOpt("help") .desc("Prints this help message") .build(); options.addOption(help); buildOptionsGroup(options); Option t = Option.builder("t") .required() .hasArg() .argName("file") .build(); Option w = Option.builder("w") .required() .hasArg() .argName("word") .build(); Option o = Option.builder("o") .hasArg() .argName("directory") .build(); options.addOption(t); options.addOption(w); options.addOption(o); return options; }
/** * Adds the deprecated command line options to the given options collection. * These are split out for purposes of not including them in the help * message. We need to add the deprecated options so as not to break * existing scripts. * * @param options a collection of command line arguments */ @SuppressWarnings({"static-access", "deprecation"}) private void addDeprecatedOptions(final Options options) { final Option proxyServer = Option.builder().argName("url").hasArg().longOpt(ARGUMENT.PROXY_URL) .desc("The proxy url argument is deprecated, use proxyserver instead.") .build(); final Option appName = Option.builder(ARGUMENT.APP_NAME_SHORT).argName("name").hasArg().longOpt(ARGUMENT.APP_NAME) .desc("The name of the project being scanned.") .build(); options.addOption(Option.builder().longOpt("disableNSP") .desc("Disable the NSP Package Analyzer.").build()); options.addOption(proxyServer); options.addOption(appName); }
@Test public void testHelpWithLongOptSeparator() throws Exception { Options options = new Options(); options.addOption( "f", true, "the file" ); options.addOption(Option.builder("s").longOpt("size").desc("the size").hasArg().argName("SIZE").build()); options.addOption(Option.builder().longOpt("age").desc("the age").hasArg().build()); HelpFormatter formatter = new HelpFormatter(); assertEquals(HelpFormatter.DEFAULT_LONG_OPT_SEPARATOR, formatter.getLongOptSeparator()); formatter.setLongOptSeparator("="); assertEquals("=", formatter.getLongOptSeparator()); StringWriter out = new StringWriter(); formatter.printHelp(new PrintWriter(out), 80, "create", "header", options, 2, 2, "footer"); assertEquals( "usage: create" + EOL + "header" + EOL + " --age=<arg> the age" + EOL + " -f <arg> the file" + EOL + " -s,--size=<SIZE> the size" + EOL + "footer" + EOL, out.toString()); }
public Option createOption() { return Option.builder(shortName).longOpt(longName).desc(description).hasArg(hasArg).build(); }
/** * Create command line option with only long name and multiple arguments. * Multiple arguments can be separated by comma or by space. * * @param longOpt long version of option * @param argName name of argument for help message * @param desc description of option */ private Option createMultiArgOpt(String longOpt, String argName, String desc) { return Option.builder().longOpt(longOpt).hasArgs().argName(argName).valueSeparator(',').desc(desc).build(); }
/** * Create command line option with only long name and no argument. * * @param longOpt long version of option * @param desc description of option */ private Option createNoArgOpt(String longOpt, String desc) { return Option.builder().longOpt(longOpt).desc(desc).build(); }
@Test public void testUsageWithLongOptSeparator() throws Exception { Options options = new Options(); options.addOption( "f", true, "the file" ); options.addOption(Option.builder("s").longOpt("size").desc("the size").hasArg().argName("SIZE").build()); options.addOption(Option.builder().longOpt("age").desc("the age").hasArg().build()); HelpFormatter formatter = new HelpFormatter(); formatter.setLongOptSeparator("="); StringWriter out = new StringWriter(); formatter.printUsage(new PrintWriter(out), 80, "create", options); assertEquals("usage: create [--age=<arg>] [-f <arg>] [-s <SIZE>]", out.toString().trim()); } }
/** * Create command line option with short name, long name, and no argument. * * @param shortOpt short version of option * @param longOpt long version of option * @param desc description of option */ private Option createNoArgOpt(String shortOpt, String longOpt, String desc) { return Option.builder(shortOpt).longOpt(longOpt).desc(desc).build(); }
private static Options createOptions() { final Options options = createHelpOptions(); options.addOption(Option.builder(PLAINTEXT_KEY).longOpt("plaintext").hasArg().required() .desc("Plaintext that needs to be encrypted") .argName("plainText").build()); options.addOption(Option.builder(PASSPHRASE_KEY).longOpt("key").hasArg().required() .desc("Passphrase used for encrypting plain text") .argName("pass phrase").build()); options.addOption(Option.builder(VERSION_KEY).longOpt("version").hasArg().required() .desc("Version it will use to encrypt Version: " + Version.versionStrings()) .argName("crypto version").build()); return options; } }
private Options buildExpectedOptions() { final Options options = new Options(); for (final Map.Entry<String, String> entry : OPTIONS_MAP.entrySet()) { final Option option = Option.builder(null).required(true).longOpt(entry.getKey()).desc(entry.getValue()).hasArg().build(); options.addOption(option); } return options; }