private void printUsage(final Options options) { final HelpFormatter formatter = new HelpFormatter(); formatter.printUsage(this.writer, CHARACTERS_PER_LINE, SingleTaskRunnerMain.class.getSimpleName(), options); }
protected void printUsageAndExit(final Options options) { final PrintWriter writer = new PrintWriter(System.out); new HelpFormatter().printUsage(writer, 180, ChronicleReaderMain.class.getSimpleName(), options); writer.flush(); System.exit(1); }
protected void printUsageAndExit(final Options options) { final PrintWriter writer = new PrintWriter(System.out); new HelpFormatter().printUsage(writer, 180, ChronicleHistoryReaderMain.class.getSimpleName(), options); writer.flush(); System.exit(1); }
private static String getOptionsHelpForUsage() { HelpFormatter formatter = new HelpFormatter(); StringWriter stringWriter = new StringWriter(); PrintWriter printWriter = new PrintWriter( stringWriter ); formatter.printUsage( printWriter, 999, "", options ); return stripOff( stringWriter.toString(), "usage: " ); // Strip off the "usage:" so it can be localized }
private String getUsageAsString() { StringWriter out = new StringWriter(); PrintWriter pw = new PrintWriter(out); helpFormatter.printUsage(pw, helpFormatter.getWidth(), "llap cache", CACHE_OPTIONS); pw.flush(); return out.toString(); }
private String getUsageAsString() { StringWriter out = new StringWriter(); PrintWriter pw = new PrintWriter(out); helpFormatter.printUsage(pw, helpFormatter.getWidth(), "llap cluster", CLUSTER_OPTIONS); pw.flush(); return out.toString(); }
printUsage(pw, width, cmdLineSyntax, options); printUsage(pw, width, cmdLineSyntax);
@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()); } }
@Test public void testPrintSortedUsageWithNullComparator() { Options opts = new Options(); opts.addOption(new Option("c", "first")); opts.addOption(new Option("b", "second")); opts.addOption(new Option("a", "third")); HelpFormatter helpFormatter = new HelpFormatter(); helpFormatter.setOptionComparator(null); StringWriter out = new StringWriter(); helpFormatter.printUsage(new PrintWriter(out), 80, "app", opts); assertEquals("usage: app [-c] [-b] [-a]" + EOL, out.toString()); }
@Test public void testPrintOptionWithEmptyArgNameUsage() { Option option = new Option("f", true, null); option.setArgName(""); option.setRequired(true); Options options = new Options(); options.addOption(option); StringWriter out = new StringWriter(); HelpFormatter formatter = new HelpFormatter(); formatter.printUsage(new PrintWriter(out), 80, "app", options); assertEquals("usage: app -f" + EOL, out.toString()); }
@Test public void testPrintUsage() { Option optionA = new Option("a", "first"); Option optionB = new Option("b", "second"); Option optionC = new Option("c", "third"); Options opts = new Options(); opts.addOption(optionA); opts.addOption(optionB); opts.addOption(optionC); HelpFormatter helpFormatter = new HelpFormatter(); ByteArrayOutputStream bytesOut = new ByteArrayOutputStream(); PrintWriter printWriter = new PrintWriter(bytesOut); helpFormatter.printUsage(printWriter, 80, "app", opts); printWriter.close(); assertEquals("usage: app [-a] [-b] [-c]" + EOL, bytesOut.toString()); }
@Test public void testDefaultArgName() { Option option = Option.builder("f").hasArg().required(true).build(); Options options = new Options(); options.addOption(option); StringWriter out = new StringWriter(); HelpFormatter formatter = new HelpFormatter(); formatter.setArgName("argument"); formatter.printUsage(new PrintWriter(out), 80, "app", options); assertEquals("usage: app -f <argument>" + EOL, out.toString()); }
@Test public void testAutomaticUsage() throws Exception { HelpFormatter hf = new HelpFormatter(); Options options = null; String expected = "usage: app [-a]"; ByteArrayOutputStream out = new ByteArrayOutputStream(); PrintWriter pw = new PrintWriter(out); options = new Options().addOption("a", false, "aaaa aaaa aaaa aaaa aaaa"); hf.printUsage(pw, 60, "app", options); pw.flush(); assertEquals("simple auto usage", expected, out.toString().trim()); out.reset(); expected = "usage: app [-a] [-b]"; options = new Options().addOption("a", false, "aaaa aaaa aaaa aaaa aaaa") .addOption("b", false, "bbb"); hf.printUsage(pw, 60, "app", options); pw.flush(); assertEquals("simple auto usage", expected, out.toString().trim()); out.reset(); }
@Test public void testPrintSortedUsage() { Options opts = new Options(); opts.addOption(new Option("a", "first")); opts.addOption(new Option("b", "second")); opts.addOption(new Option("c", "third")); HelpFormatter helpFormatter = new HelpFormatter(); helpFormatter.setOptionComparator(new Comparator<Option>() { public int compare(Option opt1, Option opt2) { // reverses the functionality of the default comparator return opt2.getKey().compareToIgnoreCase(opt1.getKey()); } }); StringWriter out = new StringWriter(); helpFormatter.printUsage(new PrintWriter(out), 80, "app", opts); assertEquals("usage: app [-c] [-b] [-a]" + EOL, out.toString()); }
@Test public void testPrintOptionGroupUsage() { OptionGroup group = new OptionGroup(); group.addOption(Option.builder("a").build()); group.addOption(Option.builder("b").build()); group.addOption(Option.builder("c").build()); Options options = new Options(); options.addOptionGroup(group); StringWriter out = new StringWriter(); HelpFormatter formatter = new HelpFormatter(); formatter.printUsage(new PrintWriter(out), 80, "app", options); assertEquals("usage: app [-a | -b | -c]" + EOL, out.toString()); }
@Test public void testPrintRequiredOptionGroupUsage() { OptionGroup group = new OptionGroup(); group.addOption(Option.builder("a").build()); group.addOption(Option.builder("b").build()); group.addOption(Option.builder("c").build()); group.setRequired(true); Options options = new Options(); options.addOptionGroup(group); StringWriter out = new StringWriter(); HelpFormatter formatter = new HelpFormatter(); formatter.printUsage(new PrintWriter(out), 80, "app", options); assertEquals("usage: app -a | -b | -c" + EOL, out.toString()); }
/** * Prints the info about a command to the given print writer. * * @param command command to print info * @param pw where to print the info */ public static void printCommandInfo(Command command, PrintWriter pw) { String description = String.format("%s: %s", command.getCommandName(), command.getDescription()); int width = 80; try { width = TerminalFactory.get().getWidth(); } catch (Exception e) { // In case the terminal factory failed to decide terminal type, use default width } HELP_FORMATTER.printWrapped(pw, width, description); HELP_FORMATTER.printUsage(pw, width, command.getUsage()); if (command.getOptions().getOptions().size() > 0) { HELP_FORMATTER.printOptions(pw, width, command.getOptions(), HELP_FORMATTER.getLeftPadding(), HELP_FORMATTER.getDescPadding()); } }
protected void printUsageAndExit(final Options options) { final PrintWriter writer = new PrintWriter(System.out); new HelpFormatter().printUsage(writer, 180, ChronicleHistoryReaderMain.class.getSimpleName(), options); writer.flush(); System.exit(1); }
protected static void usage(Options options) { HelpFormatter helpFormatter = new HelpFormatter(); PrintWriter writer = new PrintWriter(System.out); helpFormatter.printUsage(writer, 80, PersonDirectoryCreatorRunner.class.getSimpleName(), options); helpFormatter.printOptions(writer, 80, options, 1, 2); writer.flush(); }
protected static void usage(Options options) { HelpFormatter helpFormatter = new HelpFormatter(); PrintWriter writer = new PrintWriter(System.out); helpFormatter.printUsage(writer, 80, OrcidZipToHBase.class.getSimpleName(), options); helpFormatter.printOptions(writer, 80, options, 1, 2); writer.flush(); }