org.trianacode.config.cl

Class ArgumentParser

java.lang.Object

org.trianacode.config.cl.ArgumentParser

public class ArgumentParser
extends java.lang.Object

Simple convenience class to make command lines easier to deal with. String is converted into a hashtable of key/value pairs that contain the various command line arguments that the user has supplied. It also allows you to add prefixes for identifying arguments and you can return a String[] or a List or values for each parameter

Values can either be Strings (single) or lists (List) of Strings.

User: Ian Taylor

Date: Sep 24, 2010 Time: 9:35:27 AM To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
ArgumentParser(java.lang.String[] args)

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgumentPrefix(java.lang.String prefix) Adds an argument prefix to the list of prefixes that are used to identify arguments
java.lang.String[]	getArgumentAsStringValues(java.lang.String argument) Returns a list of arguments as a String[]
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getArguments() Gets the arguments along with corresponding values
java.lang.String	getArgumentValue(java.lang.String argument) returns the first value or null;
java.util.List<java.lang.String>	getArgumentValues(java.lang.String argument) Gets values fgor this argument
boolean	isOption(java.lang.String option)
void	listArguments()
void	parse()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentParser

public ArgumentParser(java.lang.String[] args)

Method Detail

addArgumentPrefix

public void addArgumentPrefix(java.lang.String prefix)

Adds an argument prefix to the list of prefixes that are used to identify arguments

Parameters:

prefix -

parse

public void parse()
           throws ArgumentParsingException

Throws:

ArgumentParsingException

getArgumentValues

public java.util.List<java.lang.String> getArgumentValues(java.lang.String argument)

Gets values fgor this argument

Parameters:

argument - argument to search for (containing the prefix)

Returns:

a List of values for this argument or bull if not found

getArgumentValue

public java.lang.String getArgumentValue(java.lang.String argument)

returns the first value or null;

Parameters:

argument -

Returns:

isOption

public boolean isOption(java.lang.String option)

getArgumentAsStringValues

public java.lang.String[] getArgumentAsStringValues(java.lang.String argument)

Returns a list of arguments as a String[]

Parameters:

argument -

Returns:

getArguments

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getArguments()

Gets the arguments along with corresponding values

Returns:

as a hashtable of key (argument as a string) and values (as a List)

listArguments

public void listArguments()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object