net.as_development.asdk.db_service.impl.backend.creator

Class CommandLineBase

java.lang.Object

net.as_development.asdk.db_service.impl.backend.creator.CommandLineBase

Direct Known Subclasses:

DBCreatorCommandLine

public abstract class CommandLineBase
extends Object

Supports operations around command lines and can be used as base class for own implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	HAS_NO_VALUE
static boolean	HAS_VALUE
static String	LIST_SEPARATOR
static boolean	NOT_REQUIRED
static String	OPT_HELP
static String	OPT_INFOLEVEL
static boolean	REQUIRED

Constructor Summary

Constructors

Constructor and Description
CommandLineBase()
CommandLineBase(String sCommandName) create a new command line instance and name it.

Method Summary

Modifier and Type	Method and Description
void	addOption(String sShort, String sLong, boolean bHasValue, boolean bRequired, String sDescription) define a new option for this command line.
void	addStdOpt_Help() add the predefined option for showing a help to this instance.
void	addStdOpt_InfoLevel() add a predefined option for logging to this instance
String	getInfoLevel()
protected String	getOptionValue(String sShort)
protected List<String>	getOptionValueAsList(String sShort)
protected boolean	hasOption(String sShort)
protected boolean	isEmpty()
boolean	needsHelp()
void	parse(String... lArgs) parse the list of command line options and set all found options on this instance.
void	printHelp() print some help info to stdout.
void	setOptionRequired(String sShort, boolean bRequired) define an option as required (mandatory) one.
protected abstract void	verify() must be overwritten by a derived class to verify the command line more in detail.

Methods inherited from class java.lang.Object

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

Field Detail

OPT_INFOLEVEL

public static final String OPT_INFOLEVEL

See Also:

Constant Field Values

OPT_HELP

public static final String OPT_HELP

See Also:

Constant Field Values

REQUIRED

public static final boolean REQUIRED

See Also:

Constant Field Values

NOT_REQUIRED

public static final boolean NOT_REQUIRED

See Also:

Constant Field Values

HAS_VALUE

public static final boolean HAS_VALUE

See Also:

Constant Field Values

HAS_NO_VALUE

public static final boolean HAS_NO_VALUE

See Also:

Constant Field Values

LIST_SEPARATOR

public static final String LIST_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

CommandLineBase

public CommandLineBase()

CommandLineBase

public CommandLineBase(String sCommandName)

create a new command line instance and name it.

Parameters:

sCommandName - [IN] the 'name' of the outside tool using that command line. Used e.g. for logging and showing help messages.

Method Detail

addStdOpt_Help

public void addStdOpt_Help()
                    throws Exception

add the predefined option for showing a help to this instance.

Throws:

Exception

addStdOpt_InfoLevel

public void addStdOpt_InfoLevel()
                         throws Exception

add a predefined option for logging to this instance

Throws:

Exception

addOption

public void addOption(String sShort,
                      String sLong,
                      boolean bHasValue,
                      boolean bRequired,
                      String sDescription)
               throws Exception

define a new option for this command line.

Parameters:

sShort - [IN] the short key for that option. Used as "-x" later.

sLong - [IN] the long key for that option. Used as "--xxxxxx" later.

bHasValue - [IN] true if that option must have a value, false if that option is a boolean option only.

bRequired - [IN] true if that option is mandatory, false otherwise.

sDescription - [IN] a short description what that option mean.

Throws:

Exception

setOptionRequired

public void setOptionRequired(String sShort,
                              boolean bRequired)
                       throws Exception

define an option as required (mandatory) one.

Parameters:

sShort - [IN] the short key for that option.

bRequired - [IN] the mandatory state (true=mandatory)

Throws:

Exception

parse

public void parse(String... lArgs)
           throws Exception

parse the list of command line options and set all found options on this instance.

Parameters:

lArgs - [IN] the list of command line arguments to be parsed here.

Throws:

Exception

getInfoLevel

public String getInfoLevel()

Returns:

the level for logging.

needsHelp

public boolean needsHelp()
                  throws Exception

Returns:

true if showing the help seems to be needed. E.g. in case there is no option given or help is requested explicit by using -h option.

Throws:

Exception

printHelp

public void printHelp()
               throws Exception

print some help info to stdout.

Throws:

Exception

verify

protected abstract void verify()
                        throws Exception

must be overwritten by a derived class to verify the command line more in detail. We can verify if required options exists or not here ... but only the derived class knows more details about possible option values. Has to throw an exception in case something is wrong on verify. We catch ALL and show the message in combination with the normal command line help then :-)

Throws:

Exception

isEmpty

protected boolean isEmpty()

Returns:

true if the given command line is empty.

getOptionValue

protected String getOptionValue(String sShort)
                         throws Exception

Parameters:

sShort - [IN] the short key of the option where the value must be returned.

Returns:

the value of the specified option. Note Return value can be null or empty.

Throws:

Exception

getOptionValueAsList

protected List<String> getOptionValueAsList(String sShort)
                                     throws Exception

Parameters:

sShort - [IN] the short key of the option where the value must be parsed.

Returns:

the value of the specified option interpreted as a list. If a value contain comma separated values you can use this method to get a parsed list of values instead one single value. Of course it's up to you to know if the value will be a list or not .-)

Throws:

Exception

hasOption

protected boolean hasOption(String sShort)
                     throws Exception

Parameters:

sShort - [IN] the short key of the option where the state has to be checked.

Returns:

true if the specified option exists (even if there is no value)

Throws:

Exception