public final class UnflaggedOption extends Option
FlaggedOption
,
Option
Constructor and Description |
---|
UnflaggedOption(java.lang.String id)
Creates a new UnflaggedOption with the specified unique ID.
|
UnflaggedOption(java.lang.String id,
StringParser stringParser,
boolean required,
java.lang.String help)
A shortcut constructor that creates a new non-greedy UnflaggedOption with no default value
and configures its most commonly used settings.
|
UnflaggedOption(java.lang.String id,
StringParser stringParser,
java.lang.String defaultValue,
boolean required,
boolean greedy)
A shortcut constructor that creates a new UnflaggedOption and configures
its most commonly used settings.
|
UnflaggedOption(java.lang.String id,
StringParser stringParser,
java.lang.String defaultValue,
boolean required,
boolean greedy,
java.lang.String help)
A shortcut constructor that creates a new UnflaggedOption and configures
its most commonly used settings.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getSyntax()
Returns syntax instructions for this FlaggedOption.
|
boolean |
isGreedy()
Returns a boolean indicating whether this UnflaggedOption is greedy.
|
UnflaggedOption |
setDefault(java.lang.String defaultValue)
Sets a default value for this parameter.
|
UnflaggedOption |
setDefault(java.lang.String[] defaultValues)
Sets one or more default values for this parameter.
|
UnflaggedOption |
setGreedy(boolean greedy)
Sets whether this UnflaggedOption is greedy.
|
UnflaggedOption |
setList(boolean isList)
Sets whether this UnflaggedOption is a list.
|
UnflaggedOption |
setListSeparator(char listSeparator)
Sets the list separator character for this UnflaggedOption.
|
UnflaggedOption |
setRequired(boolean required)
Sets whether this UnflaggedOption is required.
|
UnflaggedOption |
setStringParser(StringParser stringParser)
Sets the StringParser to which this UnflaggedOption's parse() method
should delegate.
|
UnflaggedOption |
setUsageName(java.lang.String usageName)
Sets the name that will be displayed when getUsage() is called
|
getListSeparator, getStringParser, isList, required
addDefault, getDefault, getHelp, getID, getUsage, getUsageName, setHelp
public UnflaggedOption(java.lang.String id)
id
- the unique ID for this UnflaggedOption.public UnflaggedOption(java.lang.String id, StringParser stringParser, java.lang.String defaultValue, boolean required, boolean greedy, java.lang.String help)
id
- the unique ID for this UnflaggedOptionstringParser
- the StringParser this UnflaggedOption should use.defaultValue
- the default value for this UnflaggedOption (may be
null).required
- if true, this UnflaggedOption is required.greedy
- if true, this UnflaggedOption is greedy.help
- the help text for this option (may be set to JSAP.NO_HELP
for none).public UnflaggedOption(java.lang.String id, StringParser stringParser, java.lang.String defaultValue, boolean required, boolean greedy)
id
- the unique ID for this UnflaggedOptionstringParser
- the StringParser this UnflaggedOption should use.defaultValue
- the default value for this UnflaggedOption (may be
null).required
- if true, this UnflaggedOption is required.greedy
- if true, this UnflaggedOption is greedy.public UnflaggedOption(java.lang.String id, StringParser stringParser, boolean required, java.lang.String help)
id
- the unique ID for this UnflaggedOptionstringParser
- the StringParser this UnflaggedOption should use.required
- if true, this UnflaggedOption is required.help
- the help text for this option (may be set to JSAP.NO_HELP
for none).public UnflaggedOption setGreedy(boolean greedy)
greedy
- if true, this UnflaggedOption will be greedy.public UnflaggedOption setUsageName(java.lang.String usageName)
usageName
- the name to use, or null if the id should be used (default)public boolean isGreedy()
public java.lang.String getSyntax()
public UnflaggedOption setList(boolean isList)
isList
- if true, this Option is a list.public UnflaggedOption setListSeparator(char listSeparator)
listSeparator
- the list separator for this Option.public UnflaggedOption setRequired(boolean required)
required
- if true, this Option will be required.public UnflaggedOption setStringParser(StringParser stringParser)
stringParser
- the StringParser to which this Option's parse()
method should delegate.StringParser
public UnflaggedOption setDefault(java.lang.String defaultValue)
defaultValue
- the default value for this parameter.setDefault(String)
public UnflaggedOption setDefault(java.lang.String[] defaultValues)
defaultValues
- the default values for this parameter.setDefault(String)
Copyright © 2002-2006, Martian Software, Inc.. All Rights Reserved.
For the latest version and documentation, please visit http://www.martiansoftware.com/jsap