org.finra.herd.core

Class ArgumentParser

java.lang.Object

org.finra.herd.core.ArgumentParser

public class ArgumentParser
extends Object

This class makes it easy to write user-friendly command-line interfaces. It is basically a wrapper around Apache Commons CLI.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	applicationName
protected org.apache.commons.cli.CommandLine	commandLine
protected org.apache.commons.cli.Options	options
protected org.apache.commons.cli.Options	optionsIgnoreRequired

Constructor Summary

Constructors

Constructor and Description
ArgumentParser(String applicationName)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.cli.Option	addArgument(org.apache.commons.cli.Option option, boolean required) Adds an option instance.
org.apache.commons.cli.Option	addArgument(String opt, String longOpt, boolean hasArg, String description, boolean required) Creates and adds an Option using the specified parameters.
String	getApplicationName() Returns the application name that this instance of ArgumentParser was created for.
Boolean	getBooleanValue(org.apache.commons.cli.Option option) Query to see if an option has been set.
Collection	getConfiguredOptions() Retrieve a read-only list of options in this set
File	getFileValue(org.apache.commons.cli.Option option) Retrieves the argument as a File object, if any, of an option.
File	getFileValue(org.apache.commons.cli.Option option, File defaultValue) Retrieves the argument as a File object, if any, of an option.
Integer	getIntegerValue(org.apache.commons.cli.Option option) Retrieves the argument as an Integer object, if any, of an option.
Integer	getIntegerValue(org.apache.commons.cli.Option option, Integer defaultValue) Retrieves the argument as an Integer object, if any, of an option.
Integer	getIntegerValue(org.apache.commons.cli.Option option, Integer defaultValue, Integer minValue, Integer maxValue) Retrieves the argument as an Integer object, if any, of an option and validates it against minimum and maximum allowed values.
String	getStringValue(org.apache.commons.cli.Option option) Retrieves the argument as a String object, if any, of an option.
String	getStringValue(org.apache.commons.cli.Option option, String defaultValue) Retrieves the argument as a String object, if any, of an option.
Boolean	getStringValueAsBoolean(org.apache.commons.cli.Option option, Boolean defaultValue) Retrieves the argument value, if any, as a String object and converts it to a boolean value.
String	getUsageInformation() Returns a help message, including the program usage and information about the arguments registered with the ArgumentParser.
void	parseArguments(String[] args) Parses the arguments according to the specified options.
void	parseArguments(String[] args, boolean failOnMissingRequiredOptions) Parses the arguments according to the specified options and properties.

Methods inherited from class java.lang.Object

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

Field Detail

applicationName

protected String applicationName

options

protected org.apache.commons.cli.Options options

optionsIgnoreRequired

protected org.apache.commons.cli.Options optionsIgnoreRequired

commandLine

protected org.apache.commons.cli.CommandLine commandLine

Constructor Detail

ArgumentParser

public ArgumentParser(String applicationName)

Parameters:

applicationName - The application name.

Method Detail

getApplicationName

public String getApplicationName()

Returns the application name that this instance of ArgumentParser was created for.

Returns:

the application name.

addArgument

public org.apache.commons.cli.Option addArgument(org.apache.commons.cli.Option option,
                                                 boolean required)

Adds an option instance. It may be specified as being mandatory.

Parameters:

option - the option that is to be added

required - specifies whether the option being added is mandatory

Returns:

the option that was added

addArgument

public org.apache.commons.cli.Option addArgument(String opt,
                                                 String longOpt,
                                                 boolean hasArg,
                                                 String description,
                                                 boolean required)

Creates and adds an Option using the specified parameters. The parameters contain a short-name and a long-name. It may be specified as requiring an argument and/or being mandatory.

Parameters:

opt - Short single-character name of the option.

longOpt - Long multi-character name of the option.

hasArg - flag signally if an argument is required after this option

description - Self-documenting description

required - specifies whether the option being added is mandatory

Returns:

the resulting option that was added

getConfiguredOptions

public Collection getConfiguredOptions()

Retrieve a read-only list of options in this set

Returns:

read-only Collection of Option objects in this descriptor

parseArguments

public void parseArguments(String[] args,
                           boolean failOnMissingRequiredOptions)
                    throws org.apache.commons.cli.ParseException

Parses the arguments according to the specified options and properties.

Parameters:

args - the command line arguments passed to the program

failOnMissingRequiredOptions - specifies whether to fail on any missing mandatory options

Throws:

org.apache.commons.cli.ParseException

parseArguments

public void parseArguments(String[] args)
                    throws org.apache.commons.cli.ParseException

Parses the arguments according to the specified options. The parsing fails when any of the required arguments are missing.

Parameters:

args - the command line arguments passed to the program

Throws:

org.apache.commons.cli.ParseException

getUsageInformation

public String getUsageInformation()

Returns a help message, including the program usage and information about the arguments registered with the ArgumentParser.

Returns:

the usage information about the arguments registered with the ArgumentParser.

getBooleanValue

public Boolean getBooleanValue(org.apache.commons.cli.Option option)
                        throws IllegalStateException

Query to see if an option has been set.

Parameters:

option - the option that we want to query for

Returns:

true if set, false if not

Throws:

IllegalStateException

getStringValueAsBoolean

public Boolean getStringValueAsBoolean(org.apache.commons.cli.Option option,
                                       Boolean defaultValue)
                                throws org.apache.commons.cli.ParseException

Retrieves the argument value, if any, as a String object and converts it to a boolean value.

Parameters:

option - the option that we want to query for

defaultValue - the default value to return if option is not set or missing an argument value

Returns:

the value of the argument converted to a boolean value or default value when the option is not set or missing an argument value

Throws:

org.apache.commons.cli.ParseException - if the value of the argument is an invalid boolean value

getStringValue

public String getStringValue(org.apache.commons.cli.Option option)
                      throws IllegalStateException

Retrieves the argument as a String object, if any, of an option.

Parameters:

option - the option that we want argument value to be returned for

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.

Throws:

IllegalStateException

getStringValue

public String getStringValue(org.apache.commons.cli.Option option,
                             String defaultValue)

Retrieves the argument as a String object, if any, of an option.

Parameters:

option - the option that we want argument value to be returned for

defaultValue - is the default value to be returned if the option is not specified

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.

getIntegerValue

public Integer getIntegerValue(org.apache.commons.cli.Option option)
                        throws NumberFormatException

Retrieves the argument as an Integer object, if any, of an option.

Parameters:

option - the option that we want argument value to be returned for

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.

Throws:

NumberFormatException - if there are problems parsing the option value into the Integer type

getIntegerValue

public Integer getIntegerValue(org.apache.commons.cli.Option option,
                               Integer defaultValue)
                        throws NumberFormatException

Retrieves the argument as an Integer object, if any, of an option.

Parameters:

option - the option that we want argument value to be returned for

defaultValue - is the default value to be returned if the option is not specified

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.

Throws:

NumberFormatException - if there are problems parsing the option value into the Integer type

getIntegerValue

public Integer getIntegerValue(org.apache.commons.cli.Option option,
                               Integer defaultValue,
                               Integer minValue,
                               Integer maxValue)
                        throws IllegalArgumentException

Retrieves the argument as an Integer object, if any, of an option and validates it against minimum and maximum allowed values.

Parameters:

option - the option that we want argument value to be returned for

defaultValue - is the default value to be returned if the option is not specified

minValue - the minimum allowed Integer value for the option

maxValue - the maximum allowed Integer value for the option

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.

Throws:

IllegalArgumentException - if there are problems with the option value

getFileValue

public File getFileValue(org.apache.commons.cli.Option option)

Retrieves the argument as a File object, if any, of an option.

Parameters:

option - the option that we want argument value to be returned for

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.

getFileValue

public File getFileValue(org.apache.commons.cli.Option option,
                         File defaultValue)

Retrieves the argument as a File object, if any, of an option.

Parameters:

option - the option that we want argument value to be returned for

defaultValue - is the default value to be returned if the option is not specified

Returns:

Value of the argument if option is set, and has an argument, otherwise defaultValue.