com.cs.software.engine.util

Class CmdArg

java.lang.Object

com.cs.software.engine.util.CmdArg

All Implemented Interfaces:

CmdArgIntf

Direct Known Subclasses:

CmdArgMulti, CmdArgSwitch

public class CmdArg
extends Object
implements CmdArgIntf

Title CmdArg Handles the input arguments from main

Author:

Steve Crombie

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count Describe variable count here.
protected int	counter Describe variable counter here.
protected Object	defValue Describe variable defValue here.
protected String	desc Describe variable desc here.
protected boolean	reqFlag Describe variable reqFlag here.

Constructor Summary

Constructors

Constructor and Description
CmdArg(boolean aRequired, int aCount, Object aDef, String aDescription) Creates a new CmdArg instance.
CmdArg(boolean aRequired, String aDescription) Creates a new CmdArg instance.

Method Summary

Modifier and Type	Method and Description
int	getCount() Describe getCount method here.
int	getDefError()
String	getDesc()
int	getMaxCount() Describe getMaxCount method here.
String	getTag(int anArgNumber) Describe getTag method here.
String	getValue() Describe getValue method here.
String	getValue(int anArgNumber) Describe getValue method here.
boolean	getValueSwitch() Describe getValueSwitch method here.
boolean	isRequired() Describe isRequired method here.
boolean	isSwitch() Describe isSwitch method here.
String	printArg(String aTag) Describe printArg method here.
void	setTag(String aTag) Describe setTag method here.
int	setValue(Object aObj) Describe setValue method here.
int	setValueSwitch(boolean aBool) Describe setValueSwitch method here.

Methods inherited from class java.lang.Object

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

Field Detail

defValue

protected Object defValue

Describe variable defValue here.

desc

protected String desc

Describe variable desc here.

count

protected int count

Describe variable count here.

counter

protected int counter

Describe variable counter here.

reqFlag

protected boolean reqFlag

Describe variable reqFlag here.

Constructor Detail

CmdArg

public CmdArg(boolean aRequired,
              String aDescription)

Creates a new CmdArg instance.

Parameters:

aRequired - a boolean value

aDescription - description

CmdArg

public CmdArg(boolean aRequired,
              int aCount,
              Object aDef,
              String aDescription)

Creates a new CmdArg instance.

Parameters:

aRequired - a boolean value

aCount - an int value

aDef - an Object value

aDescription - a String value

Method Detail

isSwitch

public boolean isSwitch()

Describe isSwitch method here.

Specified by:

isSwitch in interface CmdArgIntf

Returns:

a boolean value

isRequired

public boolean isRequired()

Describe isRequired method here.

Specified by:

isRequired in interface CmdArgIntf

Returns:

a boolean value

setValueSwitch

public int setValueSwitch(boolean aBool)

Describe setValueSwitch method here.

Specified by:

setValueSwitch in interface CmdArgIntf

Parameters:

aBool - a boolean value

Returns:

an int value

setValue

public int setValue(Object aObj)

Describe setValue method here.

Specified by:

setValue in interface CmdArgIntf

Parameters:

aObj - an Object value

Returns:

an int value

getMaxCount

public int getMaxCount()

Describe getMaxCount method here.

Specified by:

getMaxCount in interface CmdArgIntf

Returns:

an int value

getCount

public int getCount()

Describe getCount method here.

Specified by:

getCount in interface CmdArgIntf

Returns:

an int value

setTag

public void setTag(String aTag)

Describe setTag method here.

Specified by:

setTag in interface CmdArgIntf

Parameters:

aTag - a String value

getTag

public String getTag(int anArgNumber)

Describe getTag method here.

Specified by:

getTag in interface CmdArgIntf

Parameters:

anArgNumber - an int value

Returns:

a String value

getValue

public String getValue()

Describe getValue method here.

Specified by:

getValue in interface CmdArgIntf

Returns:

a String value

getValue

public String getValue(int anArgNumber)

Describe getValue method here.

Specified by:

getValue in interface CmdArgIntf

Parameters:

anArgNumber - an int value

Returns:

a String value

getDesc

public String getDesc()

Specified by:

getDesc in interface CmdArgIntf

getValueSwitch

public boolean getValueSwitch()

Describe getValueSwitch method here.

Specified by:

getValueSwitch in interface CmdArgIntf

Returns:

a boolean value

printArg

public String printArg(String aTag)

Describe printArg method here.

Specified by:

printArg in interface CmdArgIntf

Parameters:

aTag - a String value

Returns:

a String value

getDefError

public int getDefError()