Class ParamSpec

java.lang.Object

com.vividsolutions.jump.util.commandline.ParamSpec

public class ParamSpec
extends Object

Specifies the syntax for a single option on a command line.

Constructor Summary

Constructors

Constructor	Description
ParamSpec(String[] optNames, int numberOfNeededArgs, String desc)
ParamSpec(String optName, int needed, String desc)

Method Summary

Modifier and Type	Method	Description
Param	addParam(Vector<String> v)
Iterator<String>	getAllArguments()	merge all option args into one list e.g.
String	getDesc()
int	getNumOptions()
Param	getOption(int i)
Param	getParam()
boolean	hasArguments()
boolean	matches(String name)
void	setDoc(String docLine)

Methods inherited from class Object

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

Constructor Details

ParamSpec

public ParamSpec(String[] optNames,
 int numberOfNeededArgs,
 String desc)

ParamSpec

public ParamSpec(String optName,
 int needed,
 String desc)

Method Details

setDoc

public void setDoc(String docLine)

getDesc

public String getDesc()

getNumOptions

public int getNumOptions()

getOption

public Param getOption(int i)

getParam

public Param getParam()

Returns:

last param, if at least one was defined, else null

getAllArguments

public Iterator<String> getAllArguments()

merge all option args into one list e.g. value1, value2 from -param value1 -param value2

hasArguments

public boolean hasArguments()

matches

public boolean matches(String name)

addParam

public Param addParam(Vector<String> v)
               throws ParseException

Throws:

ParseException