com.cs.software.engine.util

Class CmdArgSwitch

java.lang.Object

com.cs.software.engine.util.CmdArg

com.cs.software.engine.util.CmdArgSwitch

All Implemented Interfaces:

CmdArgIntf

public class CmdArgSwitch
extends CmdArg

Title CmdArgSwitch Command line single parameter, this is a true/false parameter

Author:

Steve Crombie

Field Summary

Fields inherited from class com.cs.software.engine.util.CmdArg

count, counter, defValue, desc, reqFlag

Constructor Summary

Constructors

Constructor and Description
CmdArgSwitch(boolean aRequired, String aDesc) Creates a new CmdArgSwitch instance.

Method Summary

Modifier and Type	Method and Description
int	getDefError()
String	getValue() Describe getValue method here.
boolean	getValueSwitch() Describe getValueSwitch method here.
boolean	isSwitch() Describe isSwitch method here.
String	printArg(String aTag) Describe printArg method here.
int	setValueSwitch(boolean aBool) Describe setValueSwitch method here.

Methods inherited from class com.cs.software.engine.util.CmdArg

getCount, getDesc, getMaxCount, getTag, getValue, isRequired, setTag, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

CmdArgSwitch

public CmdArgSwitch(boolean aRequired,
                    String aDesc)

Creates a new CmdArgSwitch instance.

Parameters:

aRequired - a boolean value

aDesc - description

Method Detail

isSwitch

public boolean isSwitch()

Describe isSwitch method here.

Specified by:

isSwitch in interface CmdArgIntf

Overrides:

isSwitch in class CmdArg

Returns:

a boolean value

setValueSwitch

public int setValueSwitch(boolean aBool)

Describe setValueSwitch method here.

Specified by:

setValueSwitch in interface CmdArgIntf

Overrides:

setValueSwitch in class CmdArg

Parameters:

aBool - a boolean value

Returns:

an int value

getValue

public String getValue()

Describe getValue method here.

Specified by:

getValue in interface CmdArgIntf

Overrides:

getValue in class CmdArg

Returns:

a String value

getValueSwitch

public boolean getValueSwitch()

Describe getValueSwitch method here.

Specified by:

getValueSwitch in interface CmdArgIntf

Overrides:

getValueSwitch in class CmdArg

Returns:

a boolean value

printArg

public String printArg(String aTag)

Describe printArg method here.

Specified by:

printArg in interface CmdArgIntf

Overrides:

printArg in class CmdArg

Parameters:

aTag - a String value

Returns:

a String value

getDefError

public int getDefError()

Overrides:

getDefError in class CmdArg