com.dtolabs.rundeck.core.cli
Class HelpOptions

java.lang.Object
  com.dtolabs.rundeck.core.cli.HelpOptions

All Implemented Interfaces:

CLIToolOptions

public class HelpOptions
extends java.lang.Object
implements CLIToolOptions

HelpOptions adds -h/--help options.

Field Summary

static java.lang.String	HELP_OPTION short option string for usage help
static java.lang.String	HELP_OPTION_LONG long option string for usage help

Constructor Summary

HelpOptions()

Method Summary

void	addOptions(org.apache.commons.cli.Options options)
boolean	isHelpOption()
void	parseArgs(org.apache.commons.cli.CommandLine cli, java.lang.String[] original)
void	validate(org.apache.commons.cli.CommandLine cli, java.lang.String[] original)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HELP_OPTION

public static final java.lang.String HELP_OPTION

short option string for usage help

See Also:

Constant Field Values

HELP_OPTION_LONG

public static final java.lang.String HELP_OPTION_LONG

long option string for usage help

See Also:

Constant Field Values

Constructor Detail

HelpOptions

public HelpOptions()

Method Detail

addOptions

public void addOptions(org.apache.commons.cli.Options options)

Specified by:

addOptions in interface CLIToolOptions

parseArgs

public void parseArgs(org.apache.commons.cli.CommandLine cli,
                      java.lang.String[] original)
               throws CLIToolOptionsException

Specified by:

parseArgs in interface CLIToolOptions

Throws:

CLIToolOptionsException

validate

public void validate(org.apache.commons.cli.CommandLine cli,
                     java.lang.String[] original)
              throws CLIToolOptionsException

Specified by:

validate in interface CLIToolOptions

Throws:

CLIToolOptionsException

isHelpOption

public boolean isHelpOption()