Module dk.eSoftware.commandLineParser

Package dk.eSoftware.commandLineParser

Class CommandLineParser<T extends Configuration>

java.lang.Object

dk.eSoftware.commandLineParser.CommandLineParser<T>

Direct Known Subclasses:

MultiParser, SingletonCommandLineParser

public abstract class CommandLineParser<T extends Configuration>
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandLineParser.Command
static interface	CommandLineParser.ConfigBuilder<T extends Configuration>

Constructor Summary

Constructors

Constructor	Description
CommandLineParser()

Method Summary

Modifier and Type	Method	Description
protected abstract CommandLineParser.ConfigBuilder<? extends T>	getConfigBuilder(java.lang.String firstParam)	Method that must be implemented retrieving the correct configBuilder given first argument
abstract java.lang.String	help()
T	parse(java.lang.String[] input)	Utility for parsing commandline parameters into configuration objects

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineParser

public CommandLineParser()

Method Detail

parse

public T parse(java.lang.String[] input)
        throws NoSuchBuilderException,
               WrongFormatException,
               UnknownCommandException

Utility for parsing commandline parameters into configuration objects

All commands parsable by the commandLineParser is of the form: --mode --param1 -arg1 -arg2 --param2 --param3 -arg1 mode is what determines the CommandLineParser.ConfigBuilder used
Note that the first argument that the CommandLineParser.ConfigBuilder receives is always the mode argument. The mode is also able to receive get arguments, however they wont affect choice of CommandLineParser.ConfigBuilder
Both commands and arguments are stripped of their "-" or "--" prefix

Parameters:

input - the string array to be parsed

Returns:

null if input is null or empty - otherwise a Configuration created by the assigned CommandLineParser.ConfigBuilder

Throws:

NoSuchBuilderException

WrongFormatException

UnknownCommandException

getConfigBuilder

protected abstract CommandLineParser.ConfigBuilder<? extends T> getConfigBuilder(java.lang.String firstParam)
                                                                          throws NoSuchBuilderException

Method that must be implemented retrieving the correct configBuilder given first argument

Parameters:

firstParam - first argument from commandline

Returns:

CommandLineParser.ConfigBuilder to be used in parsing

Throws:

NoSuchBuilderException - when no CommandLineParser.ConfigBuilder is found

help

public abstract java.lang.String help()

Returns:

terminal-formatted string describing configuration options