Example usage for org.apache.commons.cli2.builder DefaultOptionBuilder withShortName

List of usage examples for org.apache.commons.cli2.builder DefaultOptionBuilder withShortName

Introduction

In this page you can find the example usage for org.apache.commons.cli2.builder DefaultOptionBuilder withShortName.

Prototype

public DefaultOptionBuilder withShortName(final String shortName) 

Source Link

Document

Use this short option name.

Usage

From source file:com.gsinnovations.howdah.AbstractJob.java

/** Build an option with the given parameters. Name and description are
 *  required./* w  w w.ja  v a 2 s.c o m*/
 *
 * @param name the long name of the option prefixed with '--' on the command-line
 * @param shortName the short name of the option, prefixed with '-' on the command-line
 * @param description description of the option displayed in help method
 * @param hasArg true if the option has an argument.
 * @param required true if the option is required.
 * @param defaultValue default argument value, can be null.
 * @return the option.
 */
private static Option buildOption(String name, String shortName, String description, boolean hasArg,
        boolean required, String defaultValue) {

    DefaultOptionBuilder optBuilder = new DefaultOptionBuilder().withLongName(name).withDescription(description)
            .withRequired(required);

    if (shortName != null) {
        optBuilder.withShortName(shortName);
    }

    if (hasArg) {
        ArgumentBuilder argBuilder = new ArgumentBuilder().withName(name).withMinimum(1).withMaximum(1);

        if (defaultValue != null) {
            argBuilder = argBuilder.withDefault(defaultValue);
        }

        optBuilder.withArgument(argBuilder.create());
    }

    return optBuilder.create();
}

From source file:com.ibm.jaql.util.shell.JaqlShellArguments.java

@SuppressWarnings("unchecked")
static JaqlShellArguments parseArgs(String... args) {
    // option builders
    final DefaultOptionBuilder obuilder = new DefaultOptionBuilder();
    final ArgumentBuilder abuilder = new ArgumentBuilder();
    final GroupBuilder gbuilder = new GroupBuilder();

    // create standard options
    Option optHelp = obuilder.withShortName("h").withShortName("?").withLongName("help")
            .withDescription("print this message").create();

    Option optJars = obuilder.withShortName("j").withLongName("jars")
            .withDescription(//w  w  w .  jav a 2  s  .co m
                    "comma-separated list of jar files to include user defined expressions or data stores")
            .withArgument(abuilder.withName("args").withMinimum(1).withMaximum(1).create()).create();

    Option optSearchPath = obuilder.withShortName("jp").withLongName("jaql-path")
            .withDescription("colon seperated list of all search path entries")
            .withArgument(abuilder.withName("args").withMinimum(1).withMaximum(1).create()).create();

    Option optBatch = obuilder.withShortName("b").withLongName("batch")
            .withDescription("run in batch mode (i.e., do not read from stdin)").create();

    Option optOutOptions = obuilder.withShortName("o").withLongName("outoptions")
            .withDescription("output options: json, del and xml or an output IO descriptor. "
                    + "This option is ignored when not running in batch mode.")
            .withArgument(abuilder.withName("outoptions").withMinimum(1).withMaximum(1).create()).create();

    Option optEval = obuilder.withShortName("e").withLongName("eval")
            .withDescription("evaluate Jaql expression")
            .withArgument(abuilder.withName("expr").withMinimum(1).withMaximum(1).create()).create();

    // create mini-cluster options
    Option optCluster = obuilder.withShortName("c").withLongName("cluster")
            .withDescription("use existing cluster (i.e., do not launch a mini-cluster)").create();

    Option optNumNodes = obuilder.withShortName("n").withLongName("no-nodes")
            .withDescription("mini-cluster option: number of nodes to spawn")
            .withArgument(abuilder.withName("arg").withMinimum(1).withMaximum(1)
                    .withValidator(NumberValidator.getIntegerInstance()).create())
            .create();

    Option optDir = obuilder.withShortName("d").withLongName("hdfs-dir")
            .withDescription("mini-cluster option: root HDFs directory")
            .withArgument(abuilder.withName("arg").withMinimum(1).withMaximum(1).create()).create();

    Group clusterOptions = gbuilder.withName("Cluster options").withOption(optCluster).withOption(optDir)
            .withOption(optNumNodes).create();

    // create input files option
    Option optInputFiles = abuilder.withName("file").withDescription("list of input files").withMinimum(0)
            .create();

    Option optLog = obuilder.withShortName("l").withLongName("log")
            .withDescription("log options: json, del and xml or an output IO descriptor. ")
            .withArgument(abuilder.withName("arg").withMinimum(1).withMaximum(1).create()).create();

    // combine all options
    Group options = gbuilder.withName("options").withOption(optHelp).withOption(optJars)
            .withOption(optSearchPath).withOption(optBatch).withOption(optLog).withOption(optOutOptions)
            .withOption(optEval).withOption(optInputFiles).withOption(clusterOptions).create();

    // parse and print help if necessary
    CommandLine cl;
    try {
        Parser parser = new Parser();
        parser.setGroup(options);
        cl = parser.parse(args);
    } catch (OptionException e) {
        printHelpAndExit(e, null, options);
        return null;
    }
    if (cl.hasOption(optHelp)) {
        printHelpAndExit(null, options);
    }

    // validate arguments
    JaqlShellArguments result = new JaqlShellArguments();

    // mini-cluster options         
    if (cl.hasOption(optCluster)) {
        result.useExistingCluster = true;
    }
    if (cl.hasOption(optDir)) {
        if (result.useExistingCluster) {
            printHelpAndExit("Options " + optCluster.getPreferredName() + " and " + optDir.getPreferredName()
                    + " are mutually exclusive", options);
        }
        result.hdfsDir = (String) cl.getValue(optDir);
    }
    if (cl.hasOption(optNumNodes)) {
        if (result.useExistingCluster) {
            printHelpAndExit("Options " + optCluster.getPreferredName() + " and "
                    + optNumNodes.getPreferredName() + " are mutually exclusive", options);
        }
        result.numNodes = ((Number) cl.getValue(optNumNodes)).intValue();
    }

    // jar files
    if (cl.hasOption(optJars)) {
        result.jars = ((String) cl.getValue(optJars)).split(",");
        for (String jar : result.jars) {
            if (!new File(jar).exists()) {
                printHelpAndExit("Jar file " + jar + " not found", options);
            }
        }
    }

    // search path directories
    if (cl.hasOption(optSearchPath)) {
        result.searchPath = ((String) cl.getValue(optSearchPath)).split(":");
        for (String dir : result.searchPath) {
            if (!new File(dir).exists() || !new File(dir).isDirectory()) {
                printHelpAndExit("Search-path entry " + dir + " not found or is no directory", options);
            }
        }
    }

    if (cl.hasOption(optBatch)) {
        result.batchMode = true;
        if (cl.hasOption(optOutOptions)) {
            String format = (String) cl.getValue(optOutOptions);
            try {
                result.outputAdapter = getOutputAdapter(format);
            } catch (Exception e) {
                printHelpAndExit(e,
                        "\"" + format + "\" is neither a valid output format nor a valid IO descriptor",
                        options);
            }
        }
    }

    // input
    if (cl.hasOption(optEval)) {
        String eval = (String) cl.getValue(optEval);
        if (!eval.endsWith(";"))
            eval += ";";
        result.addInputStream(new ByteArrayInputStream(eval.getBytes()));
    }
    if (cl.hasOption(optInputFiles)) {
        List<String> files = (List<String>) cl.getValues(optInputFiles);
        for (String file : files) {
            try {
                result.addInputStream(new FileInputStream(file));
            } catch (FileNotFoundException e) {
                printHelpAndExit(e, "Input file " + file + " not found", options);
            }
        }
    }

    // error log
    if (cl.hasOption(optLog)) {
        String path = (String) cl.getValue(optLog);
        try {
            BufferedJsonRecord logFD = new BufferedJsonRecord();
            logFD.add(Adapter.TYPE_NAME, new JsonString("local"));
            logFD.add(Adapter.LOCATION_NAME, new JsonString(path));
            OutputAdapter oa = (OutputAdapter) JaqlUtil.getAdapterStore().output.getAdapter(logFD);
            result.logAdapter = oa;
        } catch (Exception e) {
            printHelpAndExit(e, "\"" + path + "\" invalid", options);
        }
    }

    if (!result.batchMode) {
        result.addStdin();
    }

    return result;
}

From source file:my.mahout.AbstractJob.java

protected static Option buildOption(String name, String shortName, String description, boolean hasArg, int min,
        int max, boolean required, String defaultValue) {

    DefaultOptionBuilder optBuilder = new DefaultOptionBuilder().withLongName(name).withDescription(description)
            .withRequired(required);/*  w  w w  . j  a  va 2  s .co  m*/

    if (shortName != null) {
        optBuilder.withShortName(shortName);
    }

    if (hasArg) {
        ArgumentBuilder argBuilder = new ArgumentBuilder().withName(name).withMinimum(min).withMaximum(max);

        if (defaultValue != null) {
            argBuilder = argBuilder.withDefault(defaultValue);
        }

        optBuilder.withArgument(argBuilder.create());
    }

    return optBuilder.create();
}

From source file:egat.cli.ieds.IEDSCommandHandler.java

@Override
protected void addAdditionalChildOptions(GroupBuilder groupBuilder) {
    final DefaultOptionBuilder defaultOptionBuilder = new DefaultOptionBuilder();

    pureOption = defaultOptionBuilder.withShortName("p").withLongName("pure")
            .withDescription("pure stategy dominance").create();

    groupBuilder.withOption(pureOption);
}

From source file:it.jnrpe.server.console.PluginCommand.java

private Option toOption(PluginOption po) {
    DefaultOptionBuilder oBuilder = new DefaultOptionBuilder();

    oBuilder.withShortName(po.getOption()).withDescription(po.getDescription())
            .withRequired("true".equalsIgnoreCase(po.getRequired()));

    if (po.getLongOpt() != null) {
        oBuilder.withLongName(po.getLongOpt());
    }/*  w  w w  .j  a  v a  2  s  . c  o  m*/

    if (po.hasArgs()) {
        ArgumentBuilder aBuilder = new ArgumentBuilder();

        if (po.getArgName() != null) {
            aBuilder.withName(po.getArgName());
        }

        if (po.getArgsOptional()) {
            aBuilder.withMinimum(0);
        }

        if (po.getArgsCount() != null) {
            aBuilder.withMaximum(po.getArgsCount());
        } else {
            aBuilder.withMaximum(1);
        }

        if (po.getValueSeparator() != null && po.getValueSeparator().length() != 0) {
            aBuilder.withInitialSeparator(po.getValueSeparator().charAt(0));
            aBuilder.withSubsequentSeparator(po.getValueSeparator().charAt(0));
        }
        oBuilder.withArgument(aBuilder.create());
    }

    return oBuilder.create();
}

From source file:egat.cli.AbstractGameCommandHandler.java

protected Option createSymmetricOption() {
    DefaultOptionBuilder defaultOptionBuilder = new DefaultOptionBuilder();

    return symmetricOption = defaultOptionBuilder.withShortName("sym").withLongName("symmetric")
            .withDescription("treat game as symmetric").create();
}

From source file:egat.cli.replicatordynamics.ReplicatorDynamicsCommandHandler.java

@Override
protected void addAdditionalChildOptions(GroupBuilder groupBuilder) {
    final DefaultOptionBuilder defaultOptionBuilder = new DefaultOptionBuilder();
    final ArgumentBuilder argumentBuilder = new ArgumentBuilder();

    verboseOption = defaultOptionBuilder.withShortName("v").withLongName("verbose")
            .withDescription("prints info for each iteration").create();

    groupBuilder.withOption(verboseOption);

    toleranceOption = defaultOptionBuilder.withLongName("tolerance")
            .withArgument(argumentBuilder.withMinimum(1).withMaximum(1).withName("tol").create())
            .withDescription("minimum update L-infinity distance").create();

    groupBuilder.withOption(toleranceOption);

    maxIterationOption = defaultOptionBuilder.withLongName("max-iterations")
            .withArgument(argumentBuilder.withMinimum(1).withMaximum(1).withName("i").create())
            .withDescription("maximum iterations to run").create();

    groupBuilder.withOption(maxIterationOption);
}

From source file:com.digitalpebble.behemoth.tika.TikaDriver.java

private Option buildOption(String name, String shortName, String description, boolean hasArg, boolean required,
        String defaultValue) {/* w ww.j  ava2 s  .c  o  m*/

    DefaultOptionBuilder optBuilder = new DefaultOptionBuilder().withLongName(name).withDescription(description)
            .withRequired(required);

    if (shortName != null) {
        optBuilder.withShortName(shortName);
    }

    if (hasArg) {
        ArgumentBuilder argBuilder = new ArgumentBuilder().withName(name).withMinimum(1).withMaximum(1);

        if (defaultValue != null) {
            argBuilder = argBuilder.withDefault(defaultValue);
        }

        optBuilder.withArgument(argBuilder.create());
    }

    return optBuilder.create();
}

From source file:it.jnrpe.plugins.PluginOption.java

/**
 * Convert this {@link PluginOption} to the Option required by Apache.
 * Commons Cli./*w w w.  ja v  a  2  s.c  o m*/
 *
        
 * @return The option object required by commons cli */
public Option toOption() {
    DefaultOptionBuilder oBuilder = new DefaultOptionBuilder();

    oBuilder.withShortName(option).withDescription(description).withRequired(required);

    if (longOptionName != null) {
        oBuilder.withLongName(longOptionName);
    }

    if (hasArgs) {
        ArgumentBuilder aBuilder = new ArgumentBuilder();

        if (argName != null) {
            aBuilder.withName(argName);
        }

        if (argsAreOptional) {
            aBuilder.withMinimum(0);
        }

        if (argsCount != null) {
            aBuilder.withMaximum(argsCount);
        } else {
            aBuilder.withMaximum(1);
        }

        if (argsValueSeparator != null && argsValueSeparator.length() != 0) {
            aBuilder.withInitialSeparator(argsValueSeparator.charAt(0));
            aBuilder.withSubsequentSeparator(argsValueSeparator.charAt(0));
        }
        oBuilder.withArgument(aBuilder.create());
    }

    return oBuilder.create();
}

From source file:org.apache.mahout.df.mapred.BuildForest.java

@Override
public int run(String[] args) throws IOException {

    DefaultOptionBuilder obuilder = new DefaultOptionBuilder();
    ArgumentBuilder abuilder = new ArgumentBuilder();
    GroupBuilder gbuilder = new GroupBuilder();

    Option oobOpt = obuilder.withShortName("oob").withRequired(false)
            .withDescription("Optional, estimate the out-of-bag error").create();

    Option dataOpt = obuilder.withLongName("data").withShortName("d").withRequired(true)
            .withArgument(abuilder.withName("path").withMinimum(1).withMaximum(1).create())
            .withDescription("Data path").create();

    Option datasetOpt = obuilder.withLongName("dataset").withShortName("ds").withRequired(true)
            .withArgument(abuilder.withName("dataset").withMinimum(1).withMaximum(1).create())
            .withDescription("Dataset path").create();

    Option selectionOpt = obuilder.withLongName("selection").withShortName("sl").withRequired(true)
            .withArgument(abuilder.withName("m").withMinimum(1).withMaximum(1).create())
            .withDescription("Number of variables to select randomly at each tree-node").create();

    Option seedOpt = obuilder.withLongName("seed").withShortName("sd").withRequired(false)
            .withArgument(abuilder.withName("seed").withMinimum(1).withMaximum(1).create())
            .withDescription("Optional, seed value used to initialise the Random number generator").create();

    Option partialOpt = obuilder.withLongName("partial").withShortName("p").withRequired(false)
            .withDescription("Optional, use the Partial Data implementation").create();

    Option nbtreesOpt = obuilder.withLongName("nbtrees").withShortName("t").withRequired(true)
            .withArgument(abuilder.withName("nbtrees").withMinimum(1).withMaximum(1).create())
            .withDescription("Number of trees to grow").create();

    Option helpOpt = obuilder.withLongName("help").withDescription("Print out help").withShortName("h")
            .create();/* w  w  w  .  j  a  va  2s  .  c o m*/

    Group group = gbuilder.withName("Options").withOption(oobOpt).withOption(dataOpt).withOption(datasetOpt)
            .withOption(selectionOpt).withOption(seedOpt).withOption(partialOpt).withOption(nbtreesOpt)
            .withOption(helpOpt).create();

    try {
        Parser parser = new Parser();
        parser.setGroup(group);
        CommandLine cmdLine = parser.parse(args);

        if (cmdLine.hasOption("help")) {
            CommandLineUtil.printHelp(group);
            return -1;
        }

        isPartial = cmdLine.hasOption(partialOpt);
        isOob = cmdLine.hasOption(oobOpt);
        String dataName = cmdLine.getValue(dataOpt).toString();
        String datasetName = cmdLine.getValue(datasetOpt).toString();
        m = Integer.parseInt(cmdLine.getValue(selectionOpt).toString());
        nbTrees = Integer.parseInt(cmdLine.getValue(nbtreesOpt).toString());

        if (cmdLine.hasOption(seedOpt)) {
            seed = Long.valueOf(cmdLine.getValue(seedOpt).toString());
        }

        log.debug("data : {}", dataName);
        log.debug("dataset : {}", datasetName);
        log.debug("m : {}", m);
        log.debug("seed : {}", seed);
        log.debug("nbtrees : {}", nbTrees);
        log.debug("isPartial : {}", isPartial);
        log.debug("isOob : {}", isOob);

        dataPath = new Path(dataName);
        datasetPath = new Path(datasetName);

    } catch (OptionException e) {
        log.error("Error while parsing options", e);
        CommandLineUtil.printHelp(group);
        return -1;
    }

    buildForest();

    return 0;
}