ifs.fnd.sf.sta

Class FndArguments

java.lang.Object

ifs.fnd.sf.sta.FndArguments

public class FndArguments
extends java.lang.Object

Command line argument parser. This class have three distinct stages in it's life-cycle:

• Registering arguments.
• Parsing and validating command line arguments against the registered ones.
• Retrieving the values given at the command line

Constructor Summary

Constructors

Constructor and Description
FndArguments() Creates an FndArguments object.
FndArguments(FndArguments extraArguments) Constructs an FndArguments object with a set of arguments as extra arguments.
FndArguments(FndArguments[] extraArguments) Constructs an FndArguments object with a set of arguments as extra arguments.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getArgument(java.lang.String name) Gets the value of an argument.
boolean	getBooleanArgument(java.lang.String name) Gets the value of a boolean argument.
boolean	getEnumArgument(java.lang.String name, java.lang.String enumVal) Checks if an enumerated value was set.
int	getIntArgument(java.lang.String name) Gets the value of an integer argument.
boolean	isSet(java.lang.String name) Checks if an argument was set in the command line parameters.
void	registerArgument(java.lang.String name, java.lang.String description) Registers an argument without a default value.
void	registerArgument(java.lang.String name, java.lang.String description, java.lang.String defaultValue) Registers an argument with a default value.
void	registerBooleanArgument(java.lang.String name, java.lang.String description) Registers a boolean argument without a default value.
void	registerBooleanArgument(java.lang.String name, java.lang.String description, boolean defaultValue) Registers a boolean argument with a default value.
void	registerEnumArgument(java.lang.String name, java.lang.String description, java.lang.String[] allowedValues) Registers an enumerated argument without a default value.
void	registerEnumArgument(java.lang.String name, java.lang.String description, java.lang.String defaultValue, java.lang.String[] allowedValues) Registers an enumerated argument with a default value.
void	registerEnumSetArgument(java.lang.String name, java.lang.String description, java.lang.String[] allowedValues) Registers an enumerated argument without a default value.
void	registerEnumSetArgument(java.lang.String name, java.lang.String description, java.lang.String defaultValue, java.lang.String[] allowedValues) Registers an enumerated argument with a default value.
void	registerIntArgument(java.lang.String name, java.lang.String description) Registers an integer argument without a default value.
void	registerIntArgument(java.lang.String name, java.lang.String description, int defaultValue) Registers an integer argument with a default value.
java.lang.String	toString() Returns a String with a list of the registered arguments (with extra arguments, if they're used).
void	validateArguments(java.lang.String[] args) Parses and validates the given arguments against the registered.

Methods inherited from class java.lang.Object

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

Constructor Detail

FndArguments

public FndArguments()

Creates an FndArguments object.

FndArguments

public FndArguments(FndArguments extraArguments)

Constructs an FndArguments object with a set of arguments as extra arguments. During validation, if a given argument is not found in this object, then extraArguments is searched.

FndArguments

public FndArguments(FndArguments[] extraArguments)

Constructs an FndArguments object with a set of arguments as extra arguments. During validation, if a given argument is not found in this object, then extraArguments are searched.

Method Detail

getArgument

public java.lang.String getArgument(java.lang.String name)

Gets the value of an argument. The argument must have been added with registerArgument.

Parameters:

name - the name of the arguement to get the value for.

Returns:

a String with the arguments value.

Throws:

java.lang.IllegalArgumentException - if the argument isn't registered.

getBooleanArgument

public boolean getBooleanArgument(java.lang.String name)

Gets the value of a boolean argument. The argument must have been added with registerBooleanArgument.

Parameters:

name - the name of the arguement to get the value for.

Returns:

the argument's boolean value.

Throws:

java.lang.IllegalArgumentException - if the argument isn't registered or is not a boolean argument.

getEnumArgument

public boolean getEnumArgument(java.lang.String name,
                      java.lang.String enumVal)

Checks if an enumerated value was set. The argument must have been added with registerEnumArgument or with registerEnumSetArgument.

Parameters:

name - the name of the arguement to check the value for.

enumVal - the enumerated value to check if it was set.

Returns:

true if the enumerated value was set for the argument, false otherwise.

Throws:

java.lang.IllegalArgumentException - if the argument isn't registered or is not an enumerated argument.

getIntArgument

public int getIntArgument(java.lang.String name)

Gets the value of an integer argument. The argument must have been added with registerIntArgument(String, String).

Parameters:

name - the name of the arguement to get the value for.

Returns:

the argument's integer value.

Throws:

java.lang.IllegalArgumentException - if the argument isn't registered or is not an integer argument.

isSet

public boolean isSet(java.lang.String name)

Checks if an argument was set in the command line parameters.

Parameters:

name - the name of the argument to check if set.

Returns:

true if the argument was set, false otherwise.

registerArgument

public void registerArgument(java.lang.String name,
                    java.lang.String description)

Registers an argument without a default value.

Parameters:

name - the argument's name.

description - the argument's description.

registerArgument

public void registerArgument(java.lang.String name,
                    java.lang.String description,
                    java.lang.String defaultValue)

Registers an argument with a default value.

Parameters:

name - the argument's name.

description - the argument's description.

defaultValue - the argument's default value.

registerBooleanArgument

public void registerBooleanArgument(java.lang.String name,
                           java.lang.String description)

Registers a boolean argument without a default value.

Parameters:

name - the argument's name.

description - the argument's description.

registerBooleanArgument

public void registerBooleanArgument(java.lang.String name,
                           java.lang.String description,
                           boolean defaultValue)

Registers a boolean argument with a default value.

Parameters:

name - the argument's name.

description - the argument's description.

defaultValue - the argument's default value.

registerEnumArgument

public void registerEnumArgument(java.lang.String name,
                        java.lang.String description,
                        java.lang.String[] allowedValues)

Registers an enumerated argument without a default value. During validation one of the allowedValues can be set.

Parameters:

name - the argument's name.

description - the argument's description.

allowedValues - the allowed enumeration values.

registerEnumArgument

public void registerEnumArgument(java.lang.String name,
                        java.lang.String description,
                        java.lang.String defaultValue,
                        java.lang.String[] allowedValues)

Registers an enumerated argument with a default value. During validation one of the allowedValues can be set.

Parameters:

name - the argument's name.

description - the argument's description.

defaultValue - the argument's default value.

allowedValues - the allowed enumeration values.

registerEnumSetArgument

public void registerEnumSetArgument(java.lang.String name,
                           java.lang.String description,
                           java.lang.String[] allowedValues)

Registers an enumerated argument without a default value. During validation a (comma-separated) list of the allowedValues can be set.

Parameters:

name - the argument's name.

description - the argument's description.

allowedValues - the allowed enumeration values.

registerEnumSetArgument

public void registerEnumSetArgument(java.lang.String name,
                           java.lang.String description,
                           java.lang.String defaultValue,
                           java.lang.String[] allowedValues)

Registers an enumerated argument with a default value. During validation a (comma-separated) list of the allowedValues can be set.

Parameters:

name - the argument's name.

description - the argument's description.

defaultValue - the argument's default value.

allowedValues - the allowed enumeration values.

registerIntArgument

public void registerIntArgument(java.lang.String name,
                       java.lang.String description)

Registers an integer argument without a default value.

Parameters:

name - the argument's name.

description - the argument's description.

registerIntArgument

public void registerIntArgument(java.lang.String name,
                       java.lang.String description,
                       int defaultValue)

Registers an integer argument with a default value.

Parameters:

name - the argument's name.

description - the argument's description.

defaultValue - the argument's default value.

toString

public java.lang.String toString()

Returns a String with a list of the registered arguments (with extra arguments, if they're used). The list contains the arguments' names, type, default value & description.

Overrides:

toString in class java.lang.Object

validateArguments

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

Parses and validates the given arguments against the registered.

Parameters:

args - a String array with the parameters to parse. The Strings here must have the format param=value. If a String here starts with an @ and is followed by a filename, then the file is read and the arguments therein are parsed. The arguments in the file must have the same format (cannot reference another file tough). Empty lines, lines starting with # and -- are ignored.

Throws:

java.lang.IllegalArgumentException - if any of the arguments are given an illegal value or a non-registered argument is given.