public static class CommandLine.Model.OptionSpec extends CommandLine.Model.ArgSpec
OptionSpec
class models aspects of a named option of a command, including whether
it is required or optional, the option parameters supported (or required) by the option,
and attributes for the usage help message describing the option.
An option has one or more names. The option is matched when the parser encounters one of the option names in the command line arguments.
Depending on the option's arity
,
the parser may expect it to have option parameters. The parser will call setValue
on
the matched option for each of the option parameters encountered.
For multi-value options, the type
may be an array, a Collection
or a Map
. In this case
the parser will get the data structure by calling getValue
and modify the contents of this data structure.
(In the case of arrays, the array is replaced with a new instance with additional elements.)
Before calling the setter, picocli converts the option parameter value from a String to the option parameter's type.
converter
is configured, this will be used for type conversion.
If the option's type is a Map
, the map may have different types for its keys and its values, so
converters
should provide two converters: one for the map keys and one for the map values.type
is used to look up a converter in the list of
registered converters.
For multi-value options,
the type
may be an array, or a Collection
or a Map
. In that case the elements are converted
based on the option's auxiliaryTypes
. The auxiliaryType is used to look up
the converter(s) to use to convert the individual parameter values.
Maps may have different types for its keys and its values, so auxiliaryTypes
should provide two types: one for the map keys and one for the map values.
OptionSpec
objects are used by the picocli command line interpreter and help message generator.
Picocli can construct an OptionSpec
automatically from fields and methods with @Option
annotations. Alternatively an OptionSpec
can be constructed programmatically.
When an OptionSpec
is created from an @Option
-annotated field or method, it is "bound"
to that field or method: this field is set (or the method is invoked) when the option is matched and
setValue
is called.
Programmatically constructed OptionSpec
instances will remember the value passed to the
setValue
method so it can be retrieved with the getValue
method.
This behaviour can be customized by installing a custom CommandLine.Model.IGetter
and CommandLine.Model.ISetter
on the OptionSpec
.
Modifier and Type | Class and Description |
---|---|
static class |
CommandLine.Model.OptionSpec.Builder
Builder responsible for creating valid
OptionSpec objects. |
toString
Modifier and Type | Method and Description |
---|---|
static CommandLine.Model.OptionSpec.Builder |
builder(java.lang.String[] names) |
static CommandLine.Model.OptionSpec.Builder |
builder(java.lang.String name,
java.lang.String... names) |
java.lang.String[] |
description()
Returns the description template of this option, before variables are rendered.
|
boolean |
equals(java.lang.Object obj) |
int |
hashCode() |
boolean |
help()
Deprecated.
Use
usageHelp() and versionHelp() instead. |
protected boolean |
internalShowDefaultValue(boolean usageMessageShowDefaults)
Returns whether the default for this option or positional parameter should be shown, potentially overriding the specified global setting.
|
boolean |
isOption()
Returns
true if this argument is a named option, false otherwise. |
boolean |
isPositional()
Returns
true if this argument is a positional parameter, false otherwise. |
java.lang.String |
longestName()
Returns the longest option name.
|
java.lang.String[] |
names()
Returns one or more option names.
|
int |
order()
Returns the position in the options list in the usage help message at which this option should be shown.
|
CommandLine.Model.OptionSpec.Builder |
toBuilder()
Returns a new Builder initialized with the attributes from this
OptionSpec . |
boolean |
usageHelp()
Returns whether this option allows the user to request usage help.
|
boolean |
versionHelp()
Returns whether this option allows the user to request version information.
|
arity, auxiliaryTypes, completionCandidates, converters, defaultValue, defaultValueString, descriptionKey, equalsImpl, getter, getValue, hashCodeImpl, hasInitialValue, hidden, hideParamSyntax, initialValue, interactive, isMultiValue, messages, messages, originalStringValues, paramLabel, renderedDescription, required, resetOriginalStringValues, resetStringValues, setter, setValue, setValue, showDefaultValue, splitRegex, stringValues, toString, type, typedValues
public static CommandLine.Model.OptionSpec.Builder builder(java.lang.String name, java.lang.String... names)
public static CommandLine.Model.OptionSpec.Builder builder(java.lang.String[] names)
public CommandLine.Model.OptionSpec.Builder toBuilder()
OptionSpec
. Calling build
immediately will return a copy of this OptionSpec
.public boolean isOption()
CommandLine.Model.ArgSpec
true
if this argument is a named option, false
otherwise.isOption
in class CommandLine.Model.ArgSpec
public boolean isPositional()
CommandLine.Model.ArgSpec
true
if this argument is a positional parameter, false
otherwise.isPositional
in class CommandLine.Model.ArgSpec
protected boolean internalShowDefaultValue(boolean usageMessageShowDefaults)
CommandLine.Model.ArgSpec
internalShowDefaultValue
in class CommandLine.Model.ArgSpec
usageMessageShowDefaults
- whether the command's UsageMessageSpec is configured to show default values.public java.lang.String[] description()
fully qualified commandName + "." + descriptionKey
or for the unqualified descriptionKey
,
an attempt is made to find the option description using any of the option names (without leading hyphens) as key,
first with the fully qualified commandName + "."
prefix, then without.description
in class CommandLine.Model.ArgSpec
CommandLine.Model.CommandSpec.qualifiedName(String)
,
CommandLine.Option.description()
public java.lang.String[] names()
CommandLine.Option.names()
public java.lang.String longestName()
public int order()
CommandLine.Model.UsageMessageSpec.sortOptions()
is false
for this command.CommandLine.Option.order()
@Deprecated public boolean help()
usageHelp()
and versionHelp()
instead.CommandLine.Option.help()
public boolean usageHelp()
CommandLine.Option.usageHelp()
public boolean versionHelp()
CommandLine.Option.versionHelp()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object