com.cs.software.engine.util

Class CommandLine

java.lang.Object

com.cs.software.engine.util.CommandLine

public class CommandLine
extends Object

Title CommandLine handles all input parameters for main program

Author:

Steve Crombie

Constructor Summary

Constructors

Constructor and Description
CommandLine(String anAppName, String aVersion) Creates a new CommandLine instance.

Method Summary

Modifier and Type	Method and Description
CmdArgIntf	getCmdArg(String aTag) Describe getParam method here.
int	getDefError()
String	getParam(int anArgNumber) Describe getParam method here.
String	getParam(String aTag) Describe getParam method here.
int	getParamCount(String aTag) Describe getParamCount method here.
boolean	getParamSwitch(String aTag) Describe getParamSwitch method here.
void	initArg(String aTag, boolean aRequired) Describe initArg method here.
void	initArg(String aTag, boolean aRequired, int aCount, Object aDefaultValue, String aDescription) Describe initArg method here.
void	initArg(String aTag, boolean aRequired, String aDesc) Describe initArg method here.
static void	main(String[] args)
int	setArgs(String[] args) Describe setArgs method here.
int	setArgs(String[] args, boolean showError) Describe setArgs method here.
int	setArgsOld(String[] args) Describe setArgs method here.
int	showUsage() Describe showUsage method here.
int	showVersion() Describe showVersion method here.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLine

public CommandLine(String anAppName,
                   String aVersion)

Creates a new CommandLine instance.

Parameters:

anAppName - a String value

aVersion - a String value

Method Detail

initArg

public void initArg(String aTag,
                    boolean aRequired,
                    int aCount,
                    Object aDefaultValue,
                    String aDescription)

Describe initArg method here.

Parameters:

aTag - a String value

aRequired - a boolean value

aCount - an int value

aDefaultValue - an Object value

aDescription - a String value

initArg

public void initArg(String aTag,
                    boolean aRequired)

Describe initArg method here.

Parameters:

aTag - a String value

aRequired - a boolean value

initArg

public void initArg(String aTag,
                    boolean aRequired,
                    String aDesc)

Describe initArg method here.

Parameters:

aTag - a String value

aRequired - a boolean value

aDesc - description

setArgsOld

public int setArgsOld(String[] args)

Describe setArgs method here.

Parameters:

args - a String[] value

Returns:

an int value

setArgs

public int setArgs(String[] args)

Describe setArgs method here.

Parameters:

args - a String[] value

Returns:

an int value

setArgs

public int setArgs(String[] args,
                   boolean showError)

Describe setArgs method here.

Parameters:

args - a String[] value

showError - show error

Returns:

an int value

getParam

public String getParam(int anArgNumber)

Describe getParam method here.

Parameters:

anArgNumber - an int value

Returns:

a String value

getParam

public String getParam(String aTag)

Describe getParam method here.

Parameters:

aTag - a String value

Returns:

a String value

getParamCount

public int getParamCount(String aTag)

Describe getParamCount method here.

Parameters:

aTag - a String value

Returns:

an int value

getParamSwitch

public boolean getParamSwitch(String aTag)

Describe getParamSwitch method here.

Parameters:

aTag - a String value

Returns:

a boolean value

getCmdArg

public CmdArgIntf getCmdArg(String aTag)

Describe getParam method here.

Parameters:

aTag - a String value

Returns:

a String value

showVersion

public int showVersion()

Describe showVersion method here.

Returns:

an int value

showUsage

public int showUsage()

Describe showUsage method here.

Returns:

an int value

main

public static void main(String[] args)

getDefError

public int getDefError()