Example usage for org.apache.commons.cli OptionBuilder withDescription

List of usage examples for org.apache.commons.cli OptionBuilder withDescription

  1. HOME
  2. Java
  3. org.apache.commons
  4. org.apache.commons.cli.*
  5. OptionBuilder
  6. withDescription

Introduction

In this page you can find the example usage for org.apache.commons.cli OptionBuilder withDescription.

Prototype

public static OptionBuilder withDescription(String newDescription)

Source Link

Document

The next Option created will have the specified description

Usage

From source file:au.edu.flinders.ehl.filmweekly.FwImporter.java

private static Options createOptions() {

    Options options = new Options();

    OptionBuilder.withArgName("path");
    OptionBuilder.hasArg(true);//from  w  ww .  ja  va2s  .c  o  m
    OptionBuilder.withDescription("path to the properties file");
    OptionBuilder.isRequired(true);
    options.addOption(OptionBuilder.create("properties"));

    OptionBuilder.withArgName("path");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("optional path to the log4j properties file");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("log4j"));

    OptionBuilder.withArgName("path");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("path to the input file");
    OptionBuilder.isRequired(true);
    options.addOption(OptionBuilder.create("input"));

    OptionBuilder.withArgName("path");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("path to the coordinate list file");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("debug_coord_list"));

    OptionBuilder.withArgName("path");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("path to the json list file");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("debug_json_list"));

    return options;
}

From source file:com.sshtools.appframework.ui.SshToolsApplication.java

/**
 * Add any required command line options to be passed to the Options object
 * supplied as an argument. Concrete Applications should overidde this, call
 * super.buildCLIOptions() then add any other options they might require.
 * //  ww  w .  ja va2s.  com
 * @param options
 *            Options list to add option too
 */
public void buildCLIOptions(Options options) {
    OptionBuilder.withLongOpt("help");
    OptionBuilder.withDescription("show this help");
    Option help = OptionBuilder.create("?");
    options.addOption(help);
    if (isReuseCapable()) {
        OptionBuilder.withLongOpt("nodaemon");
        OptionBuilder.withDescription("do not start the instance re-use daemon");
        Option noListen = OptionBuilder.create("d");
        options.addOption(noListen);
    }
    OptionBuilder.withLongOpt("--reusePort");
    OptionBuilder.withArgName("port");
    OptionBuilder.hasArg();
    OptionBuilder.withDescription("port on which to listen for re-use requests");
    OptionBuilder.create("r");
    options.addOption("e", "noOptionsAction", false, "dont allow the user to change options.");
}

From source file:acromusashi.stream.tools.ConfigPutTool.java

/**
 * Generate command line analyze option object.
 * /*from   w w  w .  j av a2  s.  co m*/
 * @return command line analyze option object
 */
public static Options createOptions() {
    Options cliOptions = new Options();

    // Config path option
    OptionBuilder.hasArg(true);
    OptionBuilder.withArgName("Storm config path");
    OptionBuilder.withDescription("Storm config path");
    OptionBuilder.isRequired(false);
    Option configOption = OptionBuilder.create("c");

    // Source config path option
    OptionBuilder.hasArg(true);
    OptionBuilder.withArgName("Source config path");
    OptionBuilder.withDescription("Source config path");
    OptionBuilder.isRequired(true);
    Option sourceOption = OptionBuilder.create("s");

    // Destination config path option
    OptionBuilder.hasArg(true);
    OptionBuilder.withArgName("Destination config path");
    OptionBuilder.withDescription("Destination config path");
    OptionBuilder.isRequired(true);
    Option destinationOption = OptionBuilder.create("d");

    // User account option
    OptionBuilder.hasArg(true);
    OptionBuilder.withArgName("User account");
    OptionBuilder.withDescription("User account");
    OptionBuilder.isRequired(true);
    Option accountOption = OptionBuilder.create("ua");

    // User password option
    OptionBuilder.hasArg(true);
    OptionBuilder.withArgName("User password");
    OptionBuilder.withDescription("User password");
    OptionBuilder.isRequired(false);
    Option passwordOption = OptionBuilder.create("up");

    // Ssh port option
    OptionBuilder.hasArg(true);
    OptionBuilder.withArgName("Ssh port");
    OptionBuilder.withDescription("Ssh port");
    OptionBuilder.isRequired(false);
    Option sshPortOption = OptionBuilder.create("sp");

    // 
    OptionBuilder.withDescription("show help");
    Option helpOption = OptionBuilder.create("sh");

    cliOptions.addOption(configOption);
    cliOptions.addOption(sourceOption);
    cliOptions.addOption(destinationOption);
    cliOptions.addOption(accountOption);
    cliOptions.addOption(passwordOption);
    cliOptions.addOption(sshPortOption);
    cliOptions.addOption(helpOption);
    return cliOptions;
}

From source file:com.google.api.ads.adwords.jaxws.extensions.AwReporting.java

/**
 * Creates the command line options./*from  w w w.ja  v a2  s . c  o  m*/
 *
 * @return the {@link Options}.
 */
private static Options createCommandLineOptions() {

    Options options = new Options();
    Option help = new Option("help", "print this message");
    options.addOption(help);

    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("aw-report-sample.properties file.");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("file"));

    OptionBuilder.withArgName("YYYYMMDD");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("Start date for CUSTOM_DATE Reports (YYYYMMDD)");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("startDate"));

    OptionBuilder.withArgName("YYYMMDD");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("End date for CUSTOM_DATE Reports (YYYYMMDD)");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("endDate"));

    OptionBuilder.withArgName("DateRangeType");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("ReportDefinitionDateRangeType");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("dateRange"));

    OptionBuilder.withArgName("htmlTemplateFile> <outputDirectory");
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.hasArgs(2);
    OptionBuilder.withDescription("Generate Monthly Account Reports for all Accounts in PDF\n"
            + "NOTE: For PDF use aw-report-sample-for-pdf.properties instead, the fields need to be different.");
    options.addOption(OptionBuilder.create("generatePdf"));

    OptionBuilder.withArgName("accountIdsFile");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("Consider ONLY the account IDs specified on the file to run the report");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("accountIdsFile"));

    OptionBuilder.withArgName("verbose");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription("The application will print all the tracing on the console");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("verbose"));

    OptionBuilder.withArgName("debug");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(
            "Will display all the debug information. " + "If the option 'verbose' is activated, "
                    + "all the information will be displayed on the console as well");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("debug"));

    return options;
}

From source file:edu.rice.batchsig.bench.BenchSigner.java

@SuppressWarnings("static-access")
static public Options initOptions() {
    Options o = new Options();

    o.addOptionGroup(new OptionGroup()
            .addOption(/*  ww  w  .  ja  va 2s  .  co  m*/
                    OptionBuilder.withDescription("Sign a bunch of message from a trace").create("signtrace"))
            .addOption(OptionBuilder.withDescription("Verify messages collected via a trace")
                    .create("verifytrace"))
            .addOption(OptionBuilder.withDescription("Verify messages collected via a trace")
                    .create("makeverifytrace"))
            .addOption(OptionBuilder.withDescription("Sign a bunch of messages created at a target rate")
                    .create("sign"))
            .addOption(OptionBuilder.withDescription("Verify a bunch of messages").create("verify")))
            .addOptionGroup(new OptionGroup()
                    .addOption(OptionBuilder.withDescription("Run test with trace from from Google wave")
                            .create("wave"))
                    .addOption(OptionBuilder.withDescription("Run test with trace from email").create("email"))
                    .addOption(OptionBuilder.withDescription("Run test with trace from twitter")
                            .create("twitter")))
            .addOptionGroup(new OptionGroup()
                    .addOption(
                            OptionBuilder.withDescription("Sign each message one at a time").create("simple"))
                    .addOption(OptionBuilder.withDescription("Sign each message with merkle tree")
                            .create("merkle"))
                    .addOption(OptionBuilder.withDescription("Sign each message with history tree")
                            .create("history")))
            .addOption(OptionBuilder.withDescription("Do longer duration experiments").create("big"))
            //.addOption(OptionBuilder.withDescription("Trace to use").hasArg().create("trace"))
            .addOption(OptionBuilder
                    .withDescription(
                            "Number of senders to generate in verifytrace (prime number, not 43 or 37)")
                    .hasArg().create("verifytracesenders"))
            .addOption(OptionBuilder.withDescription("name of event trace").hasArg().create("eventtrace"))
            .addOption(OptionBuilder.withDescription("name of user logonlogoff trace").hasArg()
                    .create("usertrace"))
            .addOption(
                    OptionBuilder.withDescription("Output file (used when signing)").hasArg().create("output"))
            .addOption(
                    OptionBuilder.withDescription("Input file (used when verifying)").hasArg().create("input"))
            .addOption(OptionBuilder.withDescription("Automatically scale the signing rate").create("autorate"))
            .addOption(OptionBuilder.withDescription("Run at the given timeout").hasArg().create("timeout"))
            .addOption(OptionBuilder.withDescription("Run at the given signing rate").hasArg().create("rate"))
            .addOption(OptionBuilder.withDescription("Run at the given signing rate increment").hasArg()
                    .create("incr"))
            .addOption(OptionBuilder.withDescription("Batchsize when creating the verify trace").hasArg()
                    .create("batchsize"))
            .addOption(OptionBuilder.withDescription("Return help").create('h')).addOption(
                    OptionBuilder.withDescription("Which crypto provider to use").hasArg().create("provider"))
    //.addOption(OptionBuilder.withDescription("When verifying, which signer ID to use").hasArg().create("signerid"))
    ;

    OptionGroup tmp1 = new OptionGroup()
            .addOption(OptionBuilder.withDescription("Use DSA with the given keysize").hasOptionalArg()
                    .create("dsa"))
            .addOption(OptionBuilder.withDescription("Use RSA with the given keysize").hasOptionalArg()
                    .create("rsa"));
    tmp1.setRequired(true);
    o.addOptionGroup(tmp1);

    OptionGroup tmp2 = new OptionGroup().addOption(OptionBuilder.withDescription("Use sha256").create("sha256"))
            .addOption(OptionBuilder.withDescription("Use sha1").create("sha1"));
    tmp2.setRequired(true);
    o.addOptionGroup(tmp2);

    return o;
}

From source file:com.google.api.ads.adwords.awalerting.AwAlerting.java

/**
 * Creates the command line options./* ww w .j a  v a  2s  .  c o  m*/
 *
 * @return the {@link Options}
 */
private static Options createCommandLineOptions() {
    Options options = new Options();

    OptionBuilder.withArgName("help");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription("print this message");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("help"));

    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("aw-report-alerting-sample.properties file.");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("file"));

    OptionBuilder.withArgName("accountIdsFile");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("Consider ONLY the account IDs specified on the file to run the report");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("accountIdsFile"));

    OptionBuilder.withArgName("debug");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(
            "Will display all the debug information. " + "If the option 'verbose' is activated, "
                    + "all the information will be displayed on the console as well");
    OptionBuilder.isRequired(false);
    options.addOption(OptionBuilder.create("debug"));

    return options;
}

From source file:com.boundary.sdk.event.EventCLI.java

@SuppressWarnings("static-access")
private void addHelpOption() {
    optionHelp = OptionBuilder.withDescription("Shows help").withLongOpt("help").create(OPTION_HELP);
    options.addOption(optionHelp);/*from  w  w w  .j  a v  a2  s . c o  m*/
}

From source file:com.eucalyptus.upgrade.TestHarness.java

@SuppressWarnings({ "static-access" })
private static void printHelp(Options opts) {
    try {/*from  w w w  .  java  2  s. c o  m*/
        PrintWriter out = new PrintWriter(System.out);
        HelpFormatter help = new HelpFormatter();
        help.setArgName("TESTS");
        help.printHelp(out, LINE_BYTES, "java -jar test.jar", "Options controlling the test harness.", opts, 2,
                4, "", true);
        Multimap<Class, Method> testMethods = getTestMethods();
        help = new HelpFormatter();
        help.setLongOptPrefix("");
        help.setOptPrefix("");
        help.setSyntaxPrefix("");
        help.setLeftPadding(0);
        Options testOptions = new Options();
        for (Class c : testMethods.keySet()) {
            testOptions.addOption(
                    OptionBuilder.withDescription(getDescription(c)).withLongOpt(c.getSimpleName()).create());
            for (Method m : testMethods.get(c)) {
                testOptions.addOption(OptionBuilder.withDescription(getDescription(m))
                        .withLongOpt(c.getSimpleName() + "." + m.getName()).create());
            }
        }
        help.printHelp(out, LINE_BYTES, " ", "Tests:", testOptions, 0, 2, "", false);
        out.flush();
    } catch (Exception e) {
        System.out.println(e);
        System.exit(1);
    }
}

From source file:com.xuggle.mediatool.demos.Converter.java

/**
 * Define all the command line options this program can take.
 * /*from  w ww .  j  a  v a  2s . c  om*/
 * @return The set of accepted options.
 */
public Options defineOptions() {
    Options options = new Options();

    Option help = new Option("help", "print this message");

    /*
     * Output container options.
     */
    OptionBuilder.withArgName("container-format");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("output container format to use (e.g. \"mov\")");
    Option containerFormat = OptionBuilder.create("containerformat");

    OptionBuilder.withArgName("icontainer-format");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("input container format to use (e.g. \"mov\")");
    Option icontainerFormat = OptionBuilder.create("icontainerformat");

    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("container option presets file");
    Option cpreset = OptionBuilder.create("cpreset");

    /*
     * Audio options
     */
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription("no audio");
    Option ano = OptionBuilder.create("ano");

    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("audio option presets file");
    Option apreset = OptionBuilder.create("apreset");

    OptionBuilder.withArgName("codec");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("audio codec to encode with (e.g. \"libmp3lame\")");
    Option acodec = OptionBuilder.create("acodec");

    OptionBuilder.withArgName("icodec");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("input audio codec  (e.g. \"libmp3lame\")");
    Option iacodec = OptionBuilder.create("iacodec");

    OptionBuilder.withArgName("sample-rate");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("audio sample rate to (up/down) encode with (in hz) (e.g. \"22050\")");
    Option asamplerate = OptionBuilder.create("asamplerate");

    OptionBuilder.withArgName("isample-rate");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("input audio sample rate to (up/down) encode with (in hz) (e.g. \"22050\")");
    Option iasamplerate = OptionBuilder.create("iasamplerate");

    OptionBuilder.withArgName("channels");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("number of audio channels (1 or 2) to encode with (e.g. \"2\")");
    Option achannels = OptionBuilder.create("achannels");

    OptionBuilder.withArgName("ichannels");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("input number of audio channels (1 or 2)");
    Option iachannels = OptionBuilder.create("iachannels");

    OptionBuilder.withArgName("abit-rate");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("bit rate to encode audio with (in bps) (e.g. \"60000\")");
    Option abitrate = OptionBuilder.create("abitrate");

    OptionBuilder.withArgName("stream");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription(
            "if multiple audio streams of a given type, this is the stream you want to output");
    Option astream = OptionBuilder.create("astream");

    OptionBuilder.withArgName("quality");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription(
            "quality setting to use for audio.  0 means same as source; higher numbers are (perversely) lower quality.  Defaults to 0.");
    Option aquality = OptionBuilder.create("aquality");

    /*
     * Video options
     */
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription("no video");
    Option vno = OptionBuilder.create("vno");

    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("video option presets file");
    Option vpreset = OptionBuilder.create("vpreset");

    OptionBuilder.withArgName("codec");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("video codec to encode with (e.g. \"mpeg4\")");
    Option vcodec = OptionBuilder.create("vcodec");

    OptionBuilder.withArgName("factor");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("scaling factor to scale output video by (e.g. \"0.75\")");
    Option vscaleFactor = OptionBuilder.create("vscalefactor");

    OptionBuilder.withArgName("vbitrate");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription("bit rate to encode video with (in bps) (e.g. \"60000\")");
    Option vbitrate = OptionBuilder.create("vbitrate");

    OptionBuilder.withArgName("vbitratetolerance");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription(
            "bit rate tolerance the bitstream is allowed to diverge from the reference (in bits) (e.g. \"1200000\")");
    Option vbitratetolerance = OptionBuilder.create("vbitratetolerance");

    OptionBuilder.withArgName("stream");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription(
            "if multiple video streams of a given type, this is the stream you want to output");
    Option vstream = OptionBuilder.create("vstream");

    OptionBuilder.withArgName("quality");
    OptionBuilder.hasArg(true);
    OptionBuilder.withDescription(
            "quality setting to use for video.  0 means same as source; higher numbers are (perversely) lower quality.  Defaults to 0.  If set, then bitrate flags are ignored.");
    Option vquality = OptionBuilder.create("vquality");

    OptionBuilder.withArgName("realtime");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(
            "attempt to encode frames at the realtime rate -- i.e. it encodes when the picture should play");
    Option realtime = OptionBuilder.create("realtime");

    options.addOption(help);
    options.addOption(containerFormat);
    options.addOption(cpreset);
    options.addOption(ano);
    options.addOption(apreset);
    options.addOption(acodec);
    options.addOption(asamplerate);
    options.addOption(achannels);
    options.addOption(abitrate);
    options.addOption(astream);
    options.addOption(aquality);
    options.addOption(vno);
    options.addOption(vpreset);
    options.addOption(vcodec);
    options.addOption(vscaleFactor);
    options.addOption(vbitrate);
    options.addOption(vbitratetolerance);
    options.addOption(vstream);
    options.addOption(vquality);

    options.addOption(icontainerFormat);
    options.addOption(iacodec);
    options.addOption(iachannels);
    options.addOption(iasamplerate);

    options.addOption(realtime);

    return options;
}

From source file:goal.tools.Run.java

/**
 * Creates the command line options.//w  w  w  . j av  a  2  s .c  o  m
 *
 * @return the command line options.
 */
private static Options createOptions() {
    Options options = new Options();

    OptionBuilder.withDescription("Print all messages");
    OptionBuilder.withLongOpt(OPTION_VERBOSE);
    options.addOption(OptionBuilder.create(OPTION_VERBOSE_SHORT));

    OptionBuilder.withDescription("Print messages from parser");
    options.addOption(OptionBuilder.create(OPTION_VERBOSE_PARSER));

    OptionBuilder.withDescription("Print messages from info");
    options.addOption(OptionBuilder.create(OPTION_VERBOSE_INFO));

    OptionBuilder.withDescription("Print messages from error");
    options.addOption(OptionBuilder.create(OPTION_VERBOSE_ERROR));

    OptionBuilder.withDescription("Print messages from warning");
    options.addOption(OptionBuilder.create(OPTION_VERBOSE_WARNING));

    options.addOption(new Option(OPTION_HELP_SHORT, OPTION_HELP, false, "Displays this help"));

    OptionBuilder.withDescription("Shows the license");
    OptionBuilder.withLongOpt(OPTION_LICENSE);
    options.addOption(OptionBuilder.create());

    OptionBuilder.withLongOpt(OPTION_VERSION);
    OptionBuilder.withDescription("Shows the current version");
    options.addOption(OptionBuilder.create());

    OptionBuilder.withLongOpt(OPTION_REPEATS);
    OptionBuilder.withArgName("number");
    OptionBuilder.withDescription("Number of times to repeat running all episodes");
    OptionBuilder.hasArg();
    OptionBuilder.withType(Number.class);
    options.addOption(OptionBuilder.create(OPTION_REPEATS_SHORT));

    OptionBuilder.withLongOpt(OPTION_TIMEOUT);
    OptionBuilder.withArgName("number");
    OptionBuilder.withDescription("Maximum time to run a system (in seconds)");
    OptionBuilder.hasArg();
    OptionBuilder.withType(Number.class);
    options.addOption(OptionBuilder.create(OPTION_TIMEOUT_SHORT));

    OptionBuilder.withLongOpt(OPTION_RECURSIVE);
    OptionBuilder.withDescription("Recursively search for mas files");
    options.addOption(OptionBuilder.create());

    OptionBuilder.withLongOpt(OPTION_DEBUG);
    OptionBuilder.withDescription("Display out put from debugger while running agent");
    options.addOption(OptionBuilder.create(OPTION_DEBUG_SHORT));

    OptionBuilder.withLongOpt(OPTION_RMI_MESSAGING);
    OptionBuilder.hasArg();
    OptionBuilder.withArgName("host");
    OptionBuilder.withDescription(
            "Use RMI messaging middleware. Host is the location of the RMI server. Using \"localhost\" will initialize a RMI server");
    options.addOption(OptionBuilder.create());

    return options;
}