com.vividsolutions.jump.util.commandline

Class OptionSpec

java.lang.Object

com.vividsolutions.jump.util.commandline.OptionSpec

public class OptionSpec
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	NARGS_ONE_OR_MORE
static int	NARGS_ZERO_OR_MORE
static int	NARGS_ZERO_OR_ONE

Constructor Summary

Constructors

Constructor and Description
OptionSpec(java.lang.String[] optNames, int needed, java.lang.String desc)
OptionSpec(java.lang.String optName, int needed, java.lang.String desc)

Method Summary

Methods

Modifier and Type	Method and Description
Option	addOption(java.util.Vector v)
java.util.Iterator	getAllOptions()
java.lang.String	getDesc()
int	getNumOptions()
Option	getOption()
Option	getOption(int i)
boolean	hasOption()
void	setDoc(java.lang.String docLine)

Methods inherited from class java.lang.Object

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

Field Detail

NARGS_ZERO_OR_MORE

public static final int NARGS_ZERO_OR_MORE

See Also:

Constant Field Values

NARGS_ONE_OR_MORE

public static final int NARGS_ONE_OR_MORE

See Also:

Constant Field Values

NARGS_ZERO_OR_ONE

public static final int NARGS_ZERO_OR_ONE

See Also:

Constant Field Values

Constructor Detail

OptionSpec

public OptionSpec(java.lang.String[] optNames,
          int needed,
          java.lang.String desc)

OptionSpec

public OptionSpec(java.lang.String optName,
          int needed,
          java.lang.String desc)

Method Detail

setDoc

public void setDoc(java.lang.String docLine)

getDesc

public java.lang.String getDesc()

getNumOptions

public int getNumOptions()

getOption

public Option getOption(int i)

getOption

public Option getOption()

getAllOptions

public java.util.Iterator getAllOptions()

hasOption

public boolean hasOption()

addOption

public Option addOption(java.util.Vector v)
                 throws ParseException

Throws:

ParseException