alma.acs.util

Class CmdLineArgs

java.lang.Object

alma.acs.util.CmdLineArgs

public class CmdLineArgs
extends java.lang.Object

Deals with commandline options (String[] args), for example to merge several sets of option specifications. An option consists of a key arg and 0...many value arguments. The method parseArgs will attempt to guess which arguments are keys and which are values, e.g. looking for a "-" prefix. This class can therefore be used for unknown sets of options.

To avoid fooling the algorithm with weird values (like "-273"), the expected option keys with their minimum number of values can be specified using the registerOption methods. This mechanism can later be extended to allow validation of required arguments.

TODO: logging and error handling

Author:

hsommer

Constructor Summary

Constructors

Constructor and Description
CmdLineArgs()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAllArgs() Returns all arguments (both options and values).
CmdLineOption[]	getRecognizedArgs() Gets all arguments that were recognized by the parser.
java.lang.String[]	getValues(CmdLineOption clo)
boolean	isSpecified(CmdLineRegisteredOption clo) Returns true if the given option clo appeared in the argument lists that were passed to parseArgs; false otherwise.
void	parseArgs(java.lang.String[] args) If called more than once without calling reset() in between, the options are merged in the style of a Map.
void	registerOption(CmdLineRegisteredOption opt)
void	registerOption(java.lang.String name, int minValuesCount)
void	reset()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdLineArgs

public CmdLineArgs()

Method Detail

reset

public void reset()

registerOption

public void registerOption(java.lang.String name,
                           int minValuesCount)

registerOption

public void registerOption(CmdLineRegisteredOption opt)

parseArgs

public void parseArgs(java.lang.String[] args)

If called more than once without calling reset() in between, the options are merged in the style of a Map.

Parameters:

args -

getAllArgs

public java.lang.String[] getAllArgs()

Returns all arguments (both options and values). If arguments were parsed more than once, the values from a later call overwrite earlier ones. Options and values that could not be distinguished during parsing appear in the original order.

Returns:

getRecognizedArgs

public CmdLineOption[] getRecognizedArgs()

Gets all arguments that were recognized by the parser. This includes arguments registered before parsing, as well as arguments recognized automatically. The values for these args can be obtained from getValues(CmdLineOption).

Returns:

isSpecified

public boolean isSpecified(CmdLineRegisteredOption clo)

Returns true if the given option clo appeared in the argument lists that were passed to parseArgs; false otherwise.

Parameters:

clo -

Returns:

boolean

getValues

public java.lang.String[] getValues(CmdLineOption clo)