gr.iccs.isense.circ4life.utils

Class ProgramOptions

java.lang.Object

gr.iccs.isense.circ4life.utils.ProgramOptions

public abstract class ProgramOptions
extends Object

Common interface and functionality of program options.

Author:

Miltiadis Koutsokeras, miltos.koutsokeras@iccs.gr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ProgramOptions.Option<T> Encapsulation of an option name and type.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ORGANIZATION Organization under which this program is developed.
protected static String	ORGANIZATION_TEAM Organization team that develops this program.

Constructor Summary

Constructors

Constructor and Description
ProgramOptions()

Method Summary

Modifier and Type	Method and Description
static <T> ProgramOptions.Option<T>	createKey(String name, Class<T> type, String usage) Helper creator of Option Hash map key objects.
Map<ProgramOptions.Option<?>,Object>	getOptions()
<T> T	getValue(String optionname, Class<T> optiontype) Get the value for an option.
<T> void	initValue(String optionname, T optionvalue, String usage) Initialize an option.
protected static boolean	isOptionValue(String[] args, int index) Check if the argument in the specified index is an assignable, non option value.
abstract boolean	parseCommandLine(String[] arguments) Parse the program's command line options.
abstract void	printUsage(PrintStream os) Prints program's usage help message to the specified output stream.
protected static String	removeQuotes(String str) Removes single or double quotes from the start and end of an input String.
<T> void	setValue(String optionname, T optionvalue) Set a value based only on option name and type.
protected abstract boolean	validateOptions() This is the program options validator and should be implemented by all subclasses.

Methods inherited from class java.lang.Object

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

Field Detail

ORGANIZATION

protected static final String ORGANIZATION

Organization under which this program is developed.

See Also:

Constant Field Values

ORGANIZATION_TEAM

protected static final String ORGANIZATION_TEAM

Organization team that develops this program.

See Also:

Constant Field Values

Constructor Detail

ProgramOptions

public ProgramOptions()

Method Detail

initValue

public <T> void initValue(String optionname,
                          T optionvalue,
                          String usage)
                   throws IllegalArgumentException

Initialize an option.

Type Parameters:

T - the type of the option value.

Parameters:

optionname - The option name to set the value for.

optionvalue - The option value to set.

usage - the option usage text.

Throws:

IllegalArgumentException - If any of the arguments is null.

setValue

public <T> void setValue(String optionname,
                         T optionvalue)
                  throws IllegalArgumentException

Set a value based only on option name and type.

Type Parameters:

T - the type of the option value.

Parameters:

optionname - The option name.

optionvalue - The option value.

Throws:

IllegalArgumentException - If any of the arguments is null.

getValue

public <T> T getValue(String optionname,
                      Class<T> optiontype)

Get the value for an option. You must specify the type of the value. Uses the hash code to retrieve from the Hash Map directly.

Type Parameters:

T - the type of the class type.

Parameters:

optionname - The option name to get the value of.

optiontype - The class type of the specified option.

Returns:

The option value.

getOptions

public final Map<ProgramOptions.Option<?>,Object> getOptions()

Returns:

The options name to value map.

createKey

public static <T> ProgramOptions.Option<T> createKey(String name,
                                                     Class<T> type,
                                                     String usage)

Helper creator of Option Hash map key objects.

Type Parameters:

T - the option type class type.

Parameters:

name - Option name.

type - Option type.

usage - Option usage, null if you want just a key for retrieval.

Returns:

a newly created option object.

printUsage

public abstract void printUsage(PrintStream os)

Prints program's usage help message to the specified output stream.

Parameters:

os - the output stream to direct messages to.

parseCommandLine

public abstract boolean parseCommandLine(String[] arguments)

Parse the program's command line options.

Parameters:

arguments - Array of String containing the command line arguments (as passed to main function of main application class).

Returns:

true on successful parsing, false otherwise.

removeQuotes

protected static String removeQuotes(String str)

Removes single or double quotes from the start and end of an input String. Unfortunately the Java VM passes quoted command line arguments to the application.

Parameters:

str - Input String which may be wrapped with single or double quotes.

Returns:

The str String without single or double quotes.

isOptionValue

protected static boolean isOptionValue(String[] args,
                                       int index)

Check if the argument in the specified index is an assignable, non option value.

Parameters:

args - Arguments String array.

index - Index of argument to check.

Returns:

true if the value in the args_index position is OK, false otherwise.

validateOptions

protected abstract boolean validateOptions()

This is the program options validator and should be implemented by all subclasses.

Returns:

true if the options set via setValue(String, Object) are valid, false otherwise.