Skip to Content
Jakarta Commons Cookbook
book

Jakarta Commons Cookbook

by Timothy M. O'Brien
November 2004
Intermediate to advanced
400 pages
10h 31m
English
O'Reilly Media, Inc.
Content preview from Jakarta Commons Cookbook

7.4. Printing Usage Information

Problem

You need to provide the user with a formatted list of available options.

Solution

Pass an Options object to a HelpFormatter and print a usage message. Example 7-1 creates the same Options object from Recipe 7.3. If the help option is specified, or if there is a problem parsing the program arguments, the printUsage() method is called to print usage information to System.out.

Example 7-1. Printing usage information with HelpFormatter

                  import org.apache.commons.cli.CommandLineParser;
                  import org.apache.commons.cli.BasicParser;
                  import org.apache.commons.cli.Options;
                  import org.apache.commons.cli.OptionBuilder;
                  import org.apache.commons.cli.OptionGroup;
                  import org.apache.commons.cli.CommandLine;
                  import org.apache.commons.cli.HelpFormatter;

                  public class SomeApp {
                      private static final String USAGE = "[-h] [-v] [-f <file> | -m <email>]";
                      private static final String HEADER =
                          "SomeApp - A fancy and expensive program, Copyright 2010 Blah.";
                      private static final String FOOTER =
                          "For more instructions, see our website at: http://www.blah123.org";

                      public 
                  static 
                  void main(String[] args) throws Exception {

        // Create a Parser
        CommandLineParser parser = new BasicParser( );
        Options options = new Options( );
        options.addOption("h", "help", false, "Print this usage 
                                                                      information");
        options.addOption("v", "verbose", false, "Print out VERBOSE information" ); OptionGroup optionGroup = new OptionGroup( ); optionGroup.addOption( OptionBuilder.hasArg(true).withArgName("file") ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Spring Boot 2.0 Projects

Spring Boot 2.0 Projects

Mohamed Shazin Sadakath
RESTful Java Web Services - Third Edition

RESTful Java Web Services - Third Edition

Balachandar Bogunuva Mohanram
Back-end Performance

Back-end Performance

Bruno Skvorc, Christopher Pitt, Tonino Jankov, Reza Lavaryan, Daniel Berman

Publisher Resources

ISBN: 059600706XCatalog PageErrata