com.vividsolutions.jump.util.commandline

Class OptionSpec

java.lang.Object

com.vividsolutions.jump.util.commandline.OptionSpec

public class OptionSpec
extends Object

Specifes the syntax for a single option on a command line. ToDo:

 - add syntax pattern parsing
      Syntax patterns are similar to Java type signatures
  F - float
  I - int
  L - long
  S - string
  B - boolean
  + - one or more
 eg:  "FIS+" takes a double, int, and one or more Strings
 

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
static String	OPTION_FREE_ARGS

Constructor Summary

Constructors

Constructor and Description
OptionSpec(String optName)
OptionSpec(String optName, int nAllowed)
OptionSpec(String optName, String _syntaxPattern)

Method Summary

Modifier and Type	Method and Description
String	getArgDesc()
String	getDocDesc()
int	getNumOptions()
Option	getOption(int i)
Iterator	getOptions()
boolean	hasOption()
void	setDoc(String _argDoc, 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

OPTION_FREE_ARGS

public static final String OPTION_FREE_ARGS

See Also:

Constant Field Values

Constructor Detail

OptionSpec

public OptionSpec(String optName)

OptionSpec

public OptionSpec(String optName,
                  int nAllowed)

OptionSpec

public OptionSpec(String optName,
                  String _syntaxPattern)

Method Detail

setDoc

public void setDoc(String _argDoc,
                   String docLine)

getArgDesc

public String getArgDesc()

getDocDesc

public String getDocDesc()

getNumOptions

public int getNumOptions()

getOption

public Option getOption(int i)

getOptions

public Iterator getOptions()

hasOption

public boolean hasOption()