org.dmd.util.parsing

Class CommandLine

java.lang.Object

org.dmd.util.parsing.CommandLine

public class CommandLine
extends Object

The CommandLine class allows for the definition of arguments to an application and the parsing of those arguments.

Version:

1.0

Author:

Peter Strong

See Also:

parseArgs(java.lang.String[])

Constructor Summary

Constructors

Constructor and Description
CommandLine() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addOption(String name, BooleanVar var, String helpText) This addOption method allows you to add the definition of a flag option to the commandline.
void	addOption(String name, IntegerVar var, String helpText) This addOption method allows you to add the definition of an option that specifies a single integer.
void	addOption(String name, StringArrayList var, String helpText) This addOption method allows you to add the definition of an option that specifies a list of strings e.g.
void	addOption(String name, StringBuffer var, String helpText) This addOption method allows you to add the definition of an option that specifies a single string.
boolean	optionFound(String name) Checks whether the given option has been found in the command line.
boolean	parseArgs(ResultSet rs, String[] args) Parses the argument vector and throws an exception if problems are found.
void	parseArgs(String[] args) Parses the argument vector and throws an exception if problems are found.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLine

public CommandLine()

Default constructor.

Method Detail

addOption

public void addOption(String name,
                      BooleanVar var,
                      String helpText)

This addOption method allows you to add the definition of a flag option to the commandline. If the option is present on the commandline, the flag variable will be set to TRUE.

Parameters:

name - the option name i.e. the part that follows the - (dash)

var - the Boolean variable that stores the flag value

helpText - text that describes the meaning of the flag

optionFound

public boolean optionFound(String name)

Checks whether the given option has been found in the command line.

Parameters:

name - String the option name

Returns:

boolean true if so

addOption

public void addOption(String name,
                      StringArrayList var,
                      String helpText)

This addOption method allows you to add the definition of an option that specifies a list of strings e.g. a list of file names.

Parameters:

name - the option name i.e. the part that follows the - (dash)

var - the string array that stores the values

helpText - text that describes the usage of the option

addOption

public void addOption(String name,
                      StringBuffer var,
                      String helpText)

This addOption method allows you to add the definition of an option that specifies a single string.

Parameters:

name - the option name i.e. the part that follows the - (dash)

var - the string that stores the value

helpText - text that describes the usage of the option

addOption

public void addOption(String name,
                      IntegerVar var,
                      String helpText)

This addOption method allows you to add the definition of an option that specifies a single integer.

Parameters:

name - the option name i.e. the part that follows the - (dash)

var - the string that stores the value

helpText - text that describes the usage of the option

parseArgs

public void parseArgs(String[] args)

Parses the argument vector and throws an exception if problems are found. Otherwise, populates the appropriate arguments flags/variables.

parseArgs

public boolean parseArgs(ResultSet rs,
                         String[] args)

Parses the argument vector and throws an exception if problems are found. Otherwise, populates the appropriate arguments flags/variables.

Parameters:

rs - Place to return errors

args - The argument vector.

Returns:

true if the arguments are valid and