broadwick

Class CliOptions

java.lang.Object

broadwick.CliOptions

public class CliOptions
extends Object

Construct and read command line arguments. This class contains methods for extracting some of the main options such as configuration file etc.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.commons.cli2.CommandLine	cmdLine
private org.apache.commons.cli2.Option	configFileOpt
private static int	LINEWIDTH
private org.apache.commons.cli2.Group	options
private static String	SPACE

Constructor Summary

Constructors

Constructor and Description
CliOptions(String[] args) Construct and provide GNU-compatible Options.

Method Summary

Modifier and Type	Method and Description
private void	buildCommandLineArguments() Construct and provide GNU-compatible Options.
String	getConfigurationFileName() Get the name of the configuration file specified on the command line.
private void	validateCommandLineArguments() Perform validation the command line arguments.

Methods inherited from class java.lang.Object

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

Field Detail

options

private org.apache.commons.cli2.Group options

LINEWIDTH

private static final int LINEWIDTH

See Also:

Constant Field Values

SPACE

private static final String SPACE

See Also:

Constant Field Values

cmdLine

private org.apache.commons.cli2.CommandLine cmdLine

configFileOpt

private org.apache.commons.cli2.Option configFileOpt

Constructor Detail

CliOptions

public CliOptions(String[] args)

Construct and provide GNU-compatible Options. Read the command line extracting the arguments, this additionally displays the help message if the command line is empty.

Parameters:

args - the command line arguments.

Method Detail

buildCommandLineArguments

private void buildCommandLineArguments()

Construct and provide GNU-compatible Options.

validateCommandLineArguments

private void validateCommandLineArguments()

Perform validation the command line arguments.

getConfigurationFileName

public final String getConfigurationFileName()

Get the name of the configuration file specified on the command line.

Returns:

the name of the configuration file specified by either the -g or -c options. If neither option is specified then we return an empty string.