me.jaimegarza.syntax.env

Class CommandLine

java.lang.Object

me.jaimegarza.syntax.env.CommandLine

public class CommandLine
extends Object

Utility class to parse command line options

Author:

jgarza

Constructor Summary

Constructors

Constructor and Description
CommandLine(String[] args) Construct a command line object

Method Summary

Modifier and Type	Method and Description
void	addOption(CommandLineOption option)
String	getOptionValue(String argName, String defaultValue) Get the value of a given option
List<String>	getParameters()
boolean	hasFlag(String flag) Check to see if a flag was given
void	parse() Perform the actual parsing of command line arguments
void	setParameters(List<String> parameters)
void	usage(String commandLine) Display the usage for this command line

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLine

public CommandLine(String[] args)

Construct a command line object

Parameters:

args - the user entered arguments

Method Detail

addOption

public void addOption(CommandLineOption option)

parse

public void parse()
           throws CommandLineParseException

Perform the actual parsing of command line arguments

Throws:

CommandLineParseException - on errors

hasFlag

public boolean hasFlag(String flag)
                throws CommandLineParseException

Check to see if a flag was given

Parameters:

flag - is the flag to check

Returns:

true if given

Throws:

CommandLineParseException - if the flag was not declared, or the option is not a flag

getOptionValue

public String getOptionValue(String argName,
                             String defaultValue)
                      throws CommandLineParseException

Get the value of a given option

Parameters:

argName - is the option to check

defaultValue - is the value if option not found

Returns:

the value, or the default value.

Throws:

CommandLineParseException - if the flag was not declared, or the option is a flag

usage

public void usage(String commandLine)

Display the usage for this command line

Parameters:

commandLine - is the header for the usage

getParameters

public List<String> getParameters()

Returns:

the parameters

setParameters

public void setParameters(List<String> parameters)

Parameters:

parameters - the parameters to set