Class com.symantec.itools.frameworks.application.commandline.Option 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.frameworks.application.commandline.Option 

Object
   |
   +----com.symantec.itools.frameworks.application.commandline.Option
public abstract class Option
extends Object

Version:
1.0
Author:
Symantec Internet Tools Division
Since:
VCafe 3.0

Variable Index

o called
o defaultValues
o flags
o hasDefault
o help
o isMandatory
o longDesc
o shortDesc

Constructor Index

o com.symantec.itools.frameworks.application.commandline.Option()
o com.symantec.itools.frameworks.application.commandline.Option(String[])

Method Index

o getConsumedCount()
o getDefaultValue()
o getFlags()
o getHelp()
o getLongDesc()
o getShortDesc()
o hasDefault()
o isMandatory()
o parseArg(String[], int)
o parseDefault()
o setCalled(boolean)
o setDefaultValue(String)
o setDefaultValue(String[])
o setFlags(String[])
o setHelp(String)
o setLongDesc(String)
o setMandatory(boolean)
o setShortDesc(String)
o toString()
o wasCalled()

Variables

o called 
protected boolean called

Since: VCafe 3.0
o defaultValues 
protected java.lang.String[] defaultValues

Since: VCafe 3.0
o flags 
protected java.lang.String[] flags

Since: VCafe 3.0
o hasDefault 
protected boolean hasDefault

Since: VCafe 3.0
o help 
protected java.lang.String help

Since: VCafe 3.0
o isMandatory 
protected boolean isMandatory

Since: VCafe 3.0
o longDesc 
protected java.lang.String longDesc

Since: VCafe 3.0
o shortDesc 
protected java.lang.String shortDesc

Since: VCafe 3.0

Constructors

o Option 
protected Option()
o Option 
protected Option(String[] f)

Methods

o getConsumedCount 
protected abstract int getConsumedCount()

Since:
VCafe 3.0
o getDefaultValue 
public java.lang.String[] getDefaultValue()

Since:
VCafe 3.0
o getFlags 
public java.lang.String[] getFlags()

Since:
VCafe 3.0
o getHelp 
public java.lang.String getHelp()

Since:
VCafe 3.0
o getLongDesc 
public java.lang.String getLongDesc()

Since:
VCafe 3.0
o getShortDesc 
public java.lang.String getShortDesc()

Since:
VCafe 3.0
o hasDefault 
public boolean hasDefault()

Since:
VCafe 3.0
o isMandatory 
public boolean isMandatory()

Since:
VCafe 3.0
o parseArg 
public abstract void parseArg(String[] args,
                              int startIndex) throws InvalidArgumentException

Parameters:
args - TODO
startIndex - TODO
Throws: InvalidArgumentException
Since:
VCafe 3.0
o parseDefault 
public void parseDefault() throws InvalidArgumentException

Throws: InvalidArgumentException
Since:
VCafe 3.0
o setCalled 
public void setCalled(boolean f)

Parameters:
f - TODO
Since:
VCafe 3.0
o setDefaultValue 
public void setDefaultValue(String str)

Parameters:
str - TODO
Since:
VCafe 3.0
o setDefaultValue 
public void setDefaultValue(String[] array)

Parameters:
array - TODO
Since:
VCafe 3.0
o setFlags 
public void setFlags(String[] f)

Parameters:
f - TODO
Since:
VCafe 3.0
o setHelp 
public void setHelp(String str)

Parameters:
str - TODO
Since:
VCafe 3.0
o setLongDesc 
public void setLongDesc(String str)

Parameters:
str - TODO
Since:
VCafe 3.0
o setMandatory 
public void setMandatory(boolean f)

Parameters:
f - TODO
Since:
VCafe 3.0
o setShortDesc 
public void setShortDesc(String str)

Parameters:
str - TODO
Since:
VCafe 3.0
o toString 
public java.lang.String toString()

Overrides:
toString in class Object
Since:
VCafe 3.0
o wasCalled 
public boolean wasCalled()

Since:
VCafe 3.0 
All Packages  Class Hierarchy  This Package  Previous  Next  Index