Module dk.eSoftware.commandLineParser

Package dk.eSoftware.commandLineParser

Class SingletonCommandLineParser<T extends Configuration>

java.lang.Object

dk.eSoftware.commandLineParser.CommandLineParser<T>

dk.eSoftware.commandLineParser.SingletonCommandLineParser<T>

public class SingletonCommandLineParser<T extends Configuration>
extends CommandLineParser<T>

Nested Class Summary

Nested classes/interfaces inherited from class dk.eSoftware.commandLineParser.CommandLineParser

CommandLineParser.Command, CommandLineParser.ConfigBuilder<T extends Configuration>

Constructor Summary

Constructors

Constructor	Description
SingletonCommandLineParser(CommandLineParser.ConfigBuilder<T> builder)	Constructor for a CommandLineParser with only one mode of operations.

Method Summary

Modifier and Type	Method	Description
protected CommandLineParser.ConfigBuilder<T>	getConfigBuilder(java.lang.String firstParam)	Method that must be implemented retrieving the correct configBuilder given first argument
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

SingletonCommandLineParser

public SingletonCommandLineParser(CommandLineParser.ConfigBuilder<T> builder)

Constructor for a CommandLineParser with only one mode of operations.

Parameters:

builder - the singleton builder

Method Detail

parse

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

Description copied from class: CommandLineParser

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

Overrides:

parse in class CommandLineParser<T extends Configuration>

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 CommandLineParser.ConfigBuilder<T> getConfigBuilder(java.lang.String firstParam)

Description copied from class: CommandLineParser

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

Specified by:

getConfigBuilder in class CommandLineParser<T extends Configuration>

Parameters:

firstParam - first argument from commandline

Returns:

CommandLineParser.ConfigBuilder to be used in parsing

help

public java.lang.String help()

Specified by:

help in class CommandLineParser<T extends Configuration>

Returns:

terminal-formatted string describing configuration options