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:net.sourceforge.squirrel_sql.client.ApplicationArguments.java

private Option createAnOptionWithArgument(String[] argInfo) {
    OptionBuilder.withArgName(argInfo[0]);
    OptionBuilder.hasArg();/* ww  w. j  a v  a  2 s  .  c om*/
    OptionBuilder.withDescription(argInfo[2]);
    Option opt = OptionBuilder.create(argInfo[0]);
    if (!isStringEmpty(argInfo[1])) {
        opt.setLongOpt(argInfo[1]);
    }
    return opt;
}

From source file:nl.b3p.catalog.arcgis.ArcObjectsSynchronizerMain.java

private static Options buildOptions() {
    Options options = new Options();

    options.addOption(OptionBuilder.withDescription("ArcObjects home directory").withArgName("dir").hasArg()
            .create("home"));
    options.addOption(OptionBuilder.withDescription("fgdb or sde").hasArg().isRequired().create("type"));
    options.addOption(OptionBuilder.withDescription("target dataset").hasArg().isRequired().create("dataset"));
    options.addOption(OptionBuilder.withDescription("SDE connection file").hasArg().create("sdefile"));
    options.addOption(OptionBuilder.withDescription("SDE connection string").hasArg().create("sde"));
    options.addOption(OptionBuilder// w w  w  .  ja  v  a 2s  . com
            .withDescription("Read XML metadata document with all elements to synchronise from stdin")
            .create("stdin"));

    return options;
}

From source file:nl.imvertor.common.Configurator.java

@SuppressWarnings("static-access")
public void createOption(String stepName, String longKey, String description, String argKey, Boolean isRequired)
        throws Exception {
    if (longKey == null)
        throw new Exception("Missing option \"name\" in step " + stepName);
    if (description == null)
        throw new Exception("Missing option \"tip\" in step " + stepName);
    if (argKey == null)
        throw new Exception("Missing option \"arg\" in step " + stepName);
    if (isRequired == null)
        throw new Exception("Missing option \"required\" in step " + stepName);
    boolean hasArg = (argKey != null);
    Option option;/*from   w w  w  .  j a v a  2  s.  c  o m*/
    option = OptionBuilder.withDescription(description).hasArg(hasArg).withArgName(argKey).create(longKey);
    // Options are not required for the cli processor; they are required in the chain.
    // So declare all parameters as optional and let every test check if the parameter is actually set
    // Note that this is because there is no way a parameter file can be read dynamically within the commonc CLI module. 
    // TODO check required parameters of replace commons CLI interface package
    option.setRequired(false);
    setOptionIsReady(longKey, !isRequired);
    options.addOption(option);

    // store the option to the configurator for final reporting
    writeCli(stepName, longKey, description, argKey, isRequired);

}

From source file:nl.strohalm.cyclos.setup.Arguments.java

static Options buildOptions(final Locale locale) {
    final ResourceBundle bundle = Setup.getResourceBundle(locale);
    final Options options = new Options();

    // help/*  ww w  .j a  va 2s  .  c om*/
    OptionBuilder.withLongOpt("help");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(bundle.getString("arg.help"));
    options.addOption(OptionBuilder.create('?'));

    // force
    OptionBuilder.withLongOpt("force");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(bundle.getString("arg.force"));
    options.addOption(OptionBuilder.create('f'));

    // create database
    OptionBuilder.withLongOpt("database");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(bundle.getString("arg.create-data-base"));
    options.addOption(OptionBuilder.create('d'));

    // export script
    OptionBuilder.withLongOpt("script");
    OptionBuilder.hasOptionalArg();
    OptionBuilder.withArgName("file");
    OptionBuilder.withDescription(bundle.getString("arg.export-script"));
    options.addOption(OptionBuilder.create('s'));

    // create basic data
    OptionBuilder.withLongOpt("basic-data");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(bundle.getString("arg.create-basic-data"));
    options.addOption(OptionBuilder.create('b'));

    // create initial data
    OptionBuilder.withLongOpt("initial-data");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(bundle.getString("arg.create-initial-data"));
    options.addOption(OptionBuilder.create('i'));

    // create sms data
    OptionBuilder.withLongOpt("sms-data");
    OptionBuilder.hasArg(false);
    OptionBuilder.withDescription(bundle.getString("arg.create-sms-data"));
    options.addOption(OptionBuilder.create('m'));

    return options;
}

From source file:norbert.mynemo.ui.ImportCommandParser.java

private static Options getOptions() {
    OptionBuilder.isRequired();//from   ww w . j  a  v a 2s . co m
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(OUT_ARG_NAME);
    OptionBuilder.withDescription(OUT_DESCRIPTION);
    OptionBuilder.withLongOpt(OUT_LONG_OPTION);
    Option out = OptionBuilder.create(OUT_CHAR_OPTION);

    OptionBuilder.isRequired();
    OptionBuilder.hasArgs();
    OptionBuilder.withArgName(RATINGS_ARG_NAME);
    OptionBuilder.withLongOpt(RATINGS_LONG_OPTION);
    OptionBuilder.withDescription(RATINGS_DESCRIPTION);
    Option ratings = OptionBuilder.create(RATINGS_CHAR_OPTION);

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(MOVIES_ARG_NAME);
    OptionBuilder.withLongOpt(MOVIES_LONG_OPTION);
    OptionBuilder.withDescription(MOVIES_DESCRIPTION);
    Option movies = OptionBuilder.create(MOVIES_CHAR_OPTION);

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(USER_ARG_NAME);
    OptionBuilder.withLongOpt(USER_LONG_OPTION);
    OptionBuilder.withDescription(USER_DESCRIPTION);
    Option user = OptionBuilder.create(USER_CHAR_OPTION);

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(MAX_USERS_ARG_NAME);
    OptionBuilder.withLongOpt(MAX_USERS_LONG_OPTION);
    OptionBuilder.withDescription(MAX_USERS_DESCRIPTION);
    Option maxUsers = OptionBuilder.create();

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(MIN_RATINGS_BY_MOVIE_ARG_NAME);
    OptionBuilder.withLongOpt(MIN_RATINGS_BY_MOVIE_LONG_OPTION);
    OptionBuilder.withDescription(MIN_RATINGS_BY_MOVIE_DESCRIPTION);
    Option minRatingsByMovie = OptionBuilder.create();

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(MIN_COMMON_RATINGS_ARG_NAME);
    OptionBuilder.withLongOpt(MIN_COMMON_RATINGS_LONG_OPTION);
    OptionBuilder.withDescription(MIN_COMMON_RATINGS_DESCRIPTION);
    Option minCommonRatings = OptionBuilder.create();

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(SIMILARITY_ARG_NAME);
    OptionBuilder.withLongOpt(SIMILARITY_LONG_OPTION);
    OptionBuilder.withDescription(SIMILARITY_DESCRIPTION);
    Option similarity = OptionBuilder.create(SIMILARITY_CHAR_OPTION);

    return new Options().addOption(out).addOption(ratings).addOption(movies).addOption(user).addOption(maxUsers)
            .addOption(minRatingsByMovie).addOption(minCommonRatings).addOption(similarity);
}

From source file:norbert.mynemo.ui.RecommendCommandParser.java

private static Options getOptions() {
    // algorithm option
    OptionBuilder.isRequired();//  w  w w.  j  a  va2s . c  o  m
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(ALGORITHM_ARG_NAME);
    OptionBuilder.withLongOpt(ALGORITHM_LONG_OPTION);
    OptionBuilder.withDescription(ALGORITHM_DESCRIPTION);
    Option algorithm = OptionBuilder.create(ALGORITHM_CHAR_OPTION);

    // data model option
    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(DATAMODEL_ARG_NAME);
    OptionBuilder.withLongOpt(DATAMODEL_LONG_OPTION);
    OptionBuilder.withDescription(DATAMODEL_DESCRIPTION);
    Option dataModel = OptionBuilder.create(DATAMODEL_CHAR_OPTION);

    // user option
    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(USER_ARG_NAME);
    OptionBuilder.withLongOpt(USER_LONG_OPTION);
    OptionBuilder.withDescription(USER_DESCRIPTION);
    Option user = OptionBuilder.create(USER_CHAR_OPTION);

    // recommendations option
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(RECOMMENDATIONS_ARG_NAME);
    OptionBuilder.withLongOpt(RECOMMENDATIONS_LONG_OPTION);
    OptionBuilder.withDescription(RECOMMENDATIONS_DESCRIPTION);
    Option recommendation = OptionBuilder.create(RECOMMENDATIONS_CHAR_OPTION);

    // features option
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(FEATURES_ARG_NAME);
    OptionBuilder.withLongOpt(FEATURES_LONG_OPTION);
    OptionBuilder.withDescription(FEATURES_DESCRIPTION);
    Option features = OptionBuilder.create(FEATURES_CHAR_OPTION);

    // iterations option
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(ITERATIONS_ARG_NAME);
    OptionBuilder.withLongOpt(ITERATIONS_LONG_OPTION);
    OptionBuilder.withDescription(ITERATIONS_DESCRIPTION);
    Option iterations = OptionBuilder.create(ITERATIONS_CHAR_OPTION);

    // neighbors option
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(NEIGHBORS_ARG_NAME);
    OptionBuilder.withLongOpt(NEIGHBORS_LONG_OPTION);
    OptionBuilder.withDescription(NEIGHBORS_DESCRIPTION);
    Option neighbors = OptionBuilder.create(NEIGHBORS_CHAR_OPTION);

    return new Options().addOption(algorithm).addOption(dataModel).addOption(user).addOption(neighbors)
            .addOption(recommendation).addOption(features).addOption(iterations);
}

From source file:norbert.mynemo.ui.ScrapeCommandParser.java

private static Options getOptions() {
    // out movies
    OptionBuilder.isRequired();//w  ww .j  a v a2  s. c o m
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(OUT_MOVIES_ARG_NAME);
    OptionBuilder.withLongOpt(OUT_MOVIES_LONG_OPTION);
    OptionBuilder.withDescription(OUT_MOVIES_DESCRIPTION);
    Option outMovies = OptionBuilder.create(OUT_MOVIES_CHAR_OPTION);

    // out ratings
    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(OUT_RATINGS_ARG_NAME);
    OptionBuilder.withLongOpt(OUT_RATINGS_LONG_OPTION);
    OptionBuilder.withDescription(OUT_RATINGS_DESCRIPTION);
    Option outRatings = OptionBuilder.create(OUT_RATINGS_CHAR_OPTION);

    // input files
    OptionBuilder.isRequired();
    OptionBuilder.hasArgs();
    OptionBuilder.withArgName(IN_ARG_NAME);
    OptionBuilder.withLongOpt(IN_LONG_OPTION);
    OptionBuilder.withDescription(IN_DESCRIPTION);
    Option in = OptionBuilder.create(IN_CHAR_OPTION);

    // user agent file
    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(USERAGENTS_ARG_NAME);
    OptionBuilder.withLongOpt(USERAGENTS_LONG_OPTION);
    OptionBuilder.withDescription(USERAGENTS_DESCRIPTION);
    Option userAgents = OptionBuilder.create(USERAGENTS_CHAR_OPTION);

    // movie blacklist file
    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(MOVIE_BLACKLIST_ARG_NAME);
    OptionBuilder.withLongOpt(MOVIE_BLACKLIST_LONG_OPTION);
    OptionBuilder.withDescription(MOVIE_BLACKLIST_DESCRIPTION);
    Option movieBlacklist = OptionBuilder.create();

    // user blacklist file
    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(USER_BLACKLIST_ARG_NAME);
    OptionBuilder.withLongOpt(USER_BLACKLIST_LONG_OPTION);
    OptionBuilder.withDescription(USER_BLACKLIST_DESCRIPTION);
    Option userBlacklist = OptionBuilder.create();

    return new Options().addOption(outMovies).addOption(outRatings).addOption(in).addOption(userAgents)
            .addOption(movieBlacklist).addOption(userBlacklist);
}

From source file:norbert.mynemo.ui.SelectCommandParser.java

private static Options getOptions() {
    OptionBuilder.isRequired();//from  www  .j a v  a  2  s.  c o m
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(DATAMODEL_ARG_NAME);
    OptionBuilder.withDescription(DATAMODEL_DESCRIPTION);
    OptionBuilder.withLongOpt(DATAMODEL_LONG_OPTION);
    Option dataModel = OptionBuilder.create(DATAMODEL_CHAR_OPTION);

    OptionBuilder.isRequired();
    OptionBuilder.hasArg();
    OptionBuilder.withArgName(USER_ARG_NAME);
    OptionBuilder.withLongOpt(USER_LONG_OPTION);
    OptionBuilder.withDescription(USER_DESCRIPTION);
    Option user = OptionBuilder.create(USER_CHAR_OPTION);

    OptionBuilder.hasArgs();
    OptionBuilder.withArgName(ALGORITHMS_ARG_NAME);
    OptionBuilder.withLongOpt(ALGORITHMS_LONG_OPTION);
    OptionBuilder.withDescription(ALGORITHMS_DESCRIPTION);
    Option algorithms = OptionBuilder.create(ALGORITHMS_CHAR_OPTION);

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(METRIC_ARG_NAME);
    OptionBuilder.withLongOpt(METRIC_LONG_OPTION);
    OptionBuilder.withDescription(METRIC_DESCRIPTION);
    Option metric = OptionBuilder.create(METRIC_CHAR_OPTION);

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(SPEED_ARG_NAME);
    OptionBuilder.withLongOpt(SPEED_LONG_OPTION);
    OptionBuilder.withDescription(SPEED_DESCRIPTION);
    Option speed = OptionBuilder.create(SPEED_CHAR_OPTION);

    OptionBuilder.hasArg();
    OptionBuilder.withArgName(COVERAGE_ARG_NAME);
    OptionBuilder.withLongOpt(COVERAGE_LONG_OPTION);
    OptionBuilder.withDescription(COVERAGE_DESCRIPTION);
    Option coverage = OptionBuilder.create(COVERAGE_CHAR_OPTION);

    return new Options().addOption(dataModel).addOption(user).addOption(algorithms).addOption(metric)
            .addOption(speed).addOption(coverage);
}

From source file:org.acmsl.queryj.tools.cli.QueryJCLIHelper.java

/**
 * Creates the command-line option for the <i>configuration properties</i>.
 * @return such <code>Option</code> instance.
 *//*from   w w w  .  j  a v a2  s .c  o  m*/
public Option createConfigurationOption() {
    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg();
    OptionBuilder.withDescription(CONFIGURATION_PROPERTIES_OPTION_DESCRIPTION);

    return OptionBuilder.create(CONFIGURATION_PROPERTIES_OPTION);
}

From source file:org.acmsl.queryj.tools.cli.QueryJCLIHelper.java

/**
 * Creates the command-line long option for the
 * <i>configuration properties</i>.
 * @return such <code>Option</code> instance.
 *//*from   w w w .  ja  v  a2  s  . c o m*/
public Option createConfigurationLongOption() {
    OptionBuilder.withArgName("file");
    OptionBuilder.hasArg();
    OptionBuilder.withDescription(CONFIGURATION_PROPERTIES_OPTION_DESCRIPTION);
    return OptionBuilder.create(CONFIGURATION_PROPERTIES_LONG_OPTION);
}