Example usage for org.apache.commons.cli OptionBuilder 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:com.comcast.oscar.cli.commands.MaxCPE.java

/**
 * Set option parameters for command Maximum CPE
 * @return Option/*from  w w  w.  ja  v a  2  s  . co m*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("maximum CPEs");
    OptionBuilder.hasArgs(1);
    OptionBuilder.hasOptionalArgs();
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("maxCPE");
    OptionBuilder.withDescription("Insert the maximum CPEs during file compilation EX: 5.");
    return OptionBuilder.create("m");
}

From source file:carmen.utils.CommandLineUtilities.java

/**
 * This uses the apache Jakarta CLI to parse the command line.
 * A single static instance of this class exists for global access by all parts 
 * of the program.// w  w  w.  ja v a2s .  c om
 * To use this class, a list of options must be specified and passed to this method.
 * Manditory arguments should be encoded as strings.
 * @param args The command line received by main
 * @param manditory_args A list of strings that contain the names of manditory arguments.
 * @param specified_options A list of options to use for this program.
 */
public static void initCommandLineParameters(String[] args, List<Option> specified_options,
        String[] manditory_args) {
    Options options = new Options();
    if (specified_options != null)
        for (Option option : specified_options)
            options.addOption(option);

    Option option = null;

    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg();
    OptionBuilder.withDescription("A file containing command line parameters as a Java properties file.");
    option = OptionBuilder.create("parameter_file");

    options.addOption(option);

    CommandLineParser command_line_parser = new GnuParser();
    CommandLineUtilities._properties = new Properties();
    try {
        CommandLineUtilities._command_line = command_line_parser.parse(options, args);
    } catch (ParseException e) {
        System.out.println("***ERROR: " + e.getClass() + ": " + e.getMessage());
        HelpFormatter formatter = new HelpFormatter();
        formatter.printHelp("parameters:", options);
        System.exit(0);
    }
    if (CommandLineUtilities.hasArg("parameter_file")) {
        String parameter_file = CommandLineUtilities.getOptionValue("parameter_file");
        // Read the property file.
        try {
            _properties.load(new FileInputStream(parameter_file));
        } catch (IOException e) {
            System.err.println("Problem reading parameter file: " + parameter_file);
        }
    }

    boolean failed = false;
    if (manditory_args != null) {
        for (String arg : manditory_args) {
            if (!CommandLineUtilities.hasArg(arg)) {
                failed = true;
                System.out.println("Missing argument: " + arg);
            }
        }
        if (failed) {
            HelpFormatter formatter = new HelpFormatter();
            formatter.printHelp("parameters:", options);
            System.exit(0);
        }

    }
}

From source file:com.comcast.oscar.cli.commands.DownstreamFrequency.java

/**
 * Set option parameters for command Downstream Frequency
 * @return Option/*from  w w w.  j  av a2 s.  c o  m*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("downstream frequency");
    OptionBuilder.hasArgs(1);
    OptionBuilder.hasOptionalArgs();
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("dsfreq");
    OptionBuilder.withDescription("Insert this downstream frequency during file compilation EX: 723000000.");
    return OptionBuilder.create("df");
}

From source file:com.comcast.oscar.cli.commands.DigitmapDisplay.java

/**
 * Set option parameters for command Digitmap display
 * @return Option/*from   w  w  w .j  av a 2s. c  o m*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("displaydigitmap");
    OptionBuilder.withDescription("Display the DigitMap of the input file - PacketCable ONLY.");
    return OptionBuilder.create("ddm");
}

From source file:com.comcast.oscar.cli.commands.JSONDisplay.java

/**
 * Set option parameters for command JSON display
 * @return Option/*from  www .  j ava2  s  .  c  o m*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("json");
    OptionBuilder.withDescription("Display the JSON of the input file.");
    return OptionBuilder.create("j");
}

From source file:com.comcast.oscar.cli.commands.Output.java

/**
 * Set option parameters for command Output
 * @return Option//from  w  w w . j  av a 2 s .c om
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("filename");
    OptionBuilder.hasArgs(1);
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("output");
    OptionBuilder.withDescription("Compile the input file to this output file.");
    return OptionBuilder.create("o");
}

From source file:com.comcast.oscar.cli.commands.TLVDescription.java

/**
 * Set option parameters for command TLV description
 * @return Option/*from   w ww .  j a  va 2  s  . c om*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("TLV dot notation");
    OptionBuilder.hasArgs(1);
    OptionBuilder.hasOptionalArgs();
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("tlvdescription");
    OptionBuilder.withDescription("Display the TLV description (EX: 26.1).");
    return OptionBuilder.create("td");
}

From source file:com.comcast.oscar.cli.commands.TLVtoJSON.java

/**
 * Set option parameters for command TLV to JSON display
 * @return Option/*from   w w w. java  2s  .co m*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("TLV");
    OptionBuilder.hasArgs();
    OptionBuilder.hasOptionalArgs();
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("tlv2json");
    OptionBuilder.withDescription(
            "View the JSON array of a TLV EX: 030101 (NetworkAccess: Type 3 Length 1 Value 1).");
    return OptionBuilder.create("t2j");
}

From source file:com.comcast.oscar.cli.commands.Input.java

/**
 * Set option parameters for command Input
 * @return Option/*  ww w .j  a va 2  s. com*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("filename");
    OptionBuilder.hasArgs(1);
    OptionBuilder.hasOptionalArgs();
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("input");
    OptionBuilder.withDescription("File to analyze and/or compile/decompile.");
    return OptionBuilder.create("i");
}

From source file:com.comcast.oscar.cli.commands.JSONtoTLV.java

/**
 * Set option parameters for command JSON to TLV display
 * @return Option/*from w  ww . j a  v  a  2 s  . c o  m*/
 */
public static final Option OptionParameters() {
    OptionBuilder.withArgName("filename");
    OptionBuilder.hasArgs();
    OptionBuilder.hasOptionalArgs();
    OptionBuilder.withValueSeparator(' ');
    OptionBuilder.withLongOpt("json2tlv");
    OptionBuilder.withDescription("View the TLV number of a JSON array within the file.");
    return OptionBuilder.create("j2t");
}