public final class UnflaggedOption extends Option
FlaggedOption
,
Option
Constructor and Description |
---|
UnflaggedOption(String id)
Creates a new UnflaggedOption with the specified unique ID.
|
UnflaggedOption(String id,
StringParser stringParser,
boolean required,
String help)
A shortcut constructor that creates a new non-greedy UnflaggedOption with no default value
and configures its most commonly used settings.
|
UnflaggedOption(String id,
StringParser stringParser,
String defaultValue,
boolean required,
boolean greedy)
A shortcut constructor that creates a new UnflaggedOption and configures
its most commonly used settings.
|
UnflaggedOption(String id,
StringParser stringParser,
String defaultValue,
boolean required,
boolean greedy,
String help)
A shortcut constructor that creates a new UnflaggedOption and configures
its most commonly used settings.
|
Modifier and Type | Method and Description |
---|---|
String |
getSyntax()
Returns syntax instructions for this FlaggedOption.
|
boolean |
isGreedy()
Returns a boolean indicating whether this UnflaggedOption is greedy.
|
UnflaggedOption |
setDefault(String defaultValue)
Sets a default value for this parameter.
|
UnflaggedOption |
setDefault(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(String usageName)
Sets the name that will be displayed when getUsage() is called
|
getListSeparator, getStringParser, internalSetList, internalSetListSeparator, internalSetRequired, internalSetStringParser, isList, parse, register, required, unregister
_setDefault, _setDefault, _setUsageName, addDefault, enforceParameterLock, getDefault, getHelp, getID, getUsage, getUsageName, locked, setHelp, setLocked
public UnflaggedOption(String id)
id
- the unique ID for this UnflaggedOption.public UnflaggedOption(String id, StringParser stringParser, String defaultValue, boolean required, boolean greedy, 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(String id, StringParser stringParser, 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(String id, StringParser stringParser, boolean required, 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(String usageName)
usageName
- the name to use, or null if the id should be used (default)public boolean isGreedy()
public 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(String defaultValue)
defaultValue
- the default value for this parameter.setDefault(String)
public UnflaggedOption setDefault(String[] defaultValues)
defaultValues
- the default values for this parameter.setDefault(String)
Copyright © 2016. All rights reserved.