|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.martiansoftware.jsap.Parameter
com.martiansoftware.jsap.Option
The base class from which FlaggedOption and UnflaggedOption are derived.
An Option is a Parameter
that requires some information (unlike a Switch whose mere presence is
significant).
Options may be declared as lists, or multiple values separated by a
delimiting character. An example of
a list option might be a classpath, which is a collection of paths separated
by a ":" on *nix systems and
a ";" on DOS/Windows systems. JSAP automatically separates list options
into multiple tokens before calling
their StringParsers' parse() method.
The default list separator is JSAP.DEFAULT_LISTSEPARATOR, which is defined as the platform's path separator character (":" on *nix and ";" on DOS/Windows as described above).
Flagged
,
Option
Constructor Summary | |
Option(String id)
Creates a new Option with the specified unique ID. |
Method Summary | |
char |
getListSeparator()
Returns the current list separator character for this Option. |
StringParser |
getStringParser()
Returns the StringParser to which this Option will delegate calls to its parse() method, or null if no StringParser is currently defined. |
boolean |
isList()
Returns a boolean indicating whether this Option is a list. |
boolean |
required()
Returns a boolean indicating whether this Option is required. |
Methods inherited from class com.martiansoftware.jsap.Parameter |
addDefault, getDefault, getHelp, getID, getSyntax, getUsage, getUsageName, setHelp |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Option(String id)
id
- the unique ID for this Option.Method Detail |
public final boolean isList()
public final char getListSeparator()
public final boolean required()
public final StringParser getStringParser()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |