com.kheops.util

Class ArgumentParser

java.lang.Object

com.kheops.util.ArgumentParser

public class ArgumentParser
extends java.lang.Object

Utility class that extracts parameter values from an argument array received in a main(String[]) method.
The following command line format is assumed:
java application -param1 value1 -param2 "value with spaces" -flag1
calling getArgValue("-param1", "default") would return value1 calling getArgValue("-param2", "default") would return value with spaces calling isArgPresent("-flag1") would return true.

Constructor Summary

Constructors

Constructor and Description
ArgumentParser(java.lang.String args) Constructs new instance with the specified argument line.
ArgumentParser(java.lang.String[] args) Constructs new instance with the specified array of arguments.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getArgs()
java.lang.String	getArgValue(java.lang.String argName, java.lang.String defaultValue) Extracts the value for the specified argument.
boolean	isArgPresent(java.lang.String argName) Tests if an argument name is present.
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)

Constructs new instance with the specified array of arguments.

Parameters:

args - the array of arguments

ArgumentParser

public ArgumentParser(java.lang.String args)

Constructs new instance with the specified argument line.

Parameters:

args - the argument line

Method Detail

getArgValue

public java.lang.String getArgValue(java.lang.String argName,
                                    java.lang.String defaultValue)

Extracts the value for the specified argument. The value is the argument following the requested argument name in the argument array. If not present, specified default value is returned.

Parameters:

argName - the arguement to extract the value for

defaultValue - value returned if argument name not found

Returns:

the argument value

isArgPresent

public boolean isArgPresent(java.lang.String argName)

Tests if an argument name is present. Useful for testing the presence of flags that don't have values.

Parameters:

argName - the argument name to search for

Returns:

true if the specified aruement name is found

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getArgs

public java.lang.String[] getArgs()

Returns:

the list of arguments managed by this parser