Class CommandLine.Model.ArgSpec
- java.lang.Object
-
- picocli.CommandLine.Model.ArgSpec
-
- Direct Known Subclasses:
CommandLine.Model.OptionSpec,CommandLine.Model.PositionalParamSpec
- Enclosing class:
- CommandLine.Model
public abstract static class CommandLine.Model.ArgSpec extends java.lang.ObjectModels the shared attributes ofCommandLine.Model.OptionSpecandCommandLine.Model.PositionalParamSpec.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description protected CommandLine.Model.IAnnotatedElementannotatedElementprotected java.lang.StringtoStringprotected CommandLine.Model.ITypeInfotypeInfoprotected booleanvalueIsDefaultValue
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CommandLine.Rangearity()Returns how many arguments this option or positional parameter requires.java.lang.Class<?>[]auxiliaryTypes()CommandLine.Model.CommandSpeccommand()Returns the command this option or positional parameter belongs to.java.lang.Iterable<java.lang.String>completionCandidates()Returns the explicitly set completion candidates for this option or positional parameter, valid enum constant names, ornullif this option or positional parameter does not have any completion candidates and its type is not an enum.CommandLine.ITypeConverter<?>[]converters()Returns one or moretype convertersto use to convert the command line argument into a strongly typed value (or key-value pair for map fields).java.lang.StringdefaultValue()Returns the default value to assign if this option or positional parameter was not specified on the command line, before splitting and type conversion.java.lang.StringdefaultValueString()Returns the default value String for the purpose of displaying it in the description, without interpolating variables.java.lang.StringdefaultValueString(boolean interpolateVariables)Returns the default value String displayed in the description; interpolating variables if specified.java.lang.String[]description()Returns the description of this option or positional parameter, after all variables have been rendered, including the${DEFAULT-VALUE}and${COMPLETION-CANDIDATES}variables.java.lang.StringdescriptionKey()Returns the description key of this arg spec, used to get the description from a resource bundle.booleanecho()Returns whether the user input is echoed to the console or not for an interactive option or positional parameter when asking for user input.protected booleanequalsImpl(CommandLine.Model.ArgSpec other)protected abstract java.util.Collection<java.lang.String>getAdditionalDescriptionKeys()Subclasses should override to return a collection of additional description keys that may be used to find description text for this option or positional parameter in the resource bundle.CommandLine.Model.IGettergetter()Returns theCommandLine.Model.IGetterthat is responsible for supplying the value of this argument.<T> TgetValue()Returns the current value of this argument.CommandLine.Model.ArgGroupSpecgroup()Returns the groups this option or positional parameter belongs to, ornullif this option is not part of a group.protected inthashCodeImpl()booleanhasInitialValue()Determines whether the option or positional parameter will be reset to theinitialValue()before parsing new input.booleanhidden()Returns whether this option should be excluded from the usage message.booleanhideParamSyntax()Returns whether usage syntax decorations around the paramLabel should be suppressed.booleaninherited()Returns whether this option is inherited from a parent command.java.lang.ObjectinitialValue()Returns the initial value of this option or positional parameter: the value that, ifhasInitialValue()is true, the option will be reset to before parsing (regardless of whether a default value exists), to clear values that would otherwise remain from parsing previous input.booleaninteractive()Returns whether this option will prompt the user to enter a value on the command line.protected booleaninternalShowDefaultValue(boolean usageHelpShowDefaults)Returns whether the default for this option or positional parameter should be shown, potentially overriding the specified global setting.booleanisMultiValue()abstract booleanisOption()Returnstrueif this argument is a named option,falseotherwise.abstract booleanisPositional()Returnstrueif this argument is a positional parameter,falseotherwise.booleanisValueGettable()Check whether thegetValue()method is able to get an actual value from the currentgetter().java.lang.StringmapFallbackValue()Returns the fallback value for this Map option or positional parameter: the value that is put into the Map when only the key is specified for the option or positional parameter, like-Dkeyinstead of-Dkey=value.CommandLine.Model.Messagesmessages()Returns the Messages for this arg specification, ornull.CommandLine.Model.ArgSpecmessages(CommandLine.Model.Messages msgs)Sets the Messages for this ArgSpec, and returns this ArgSpec.booleanoriginallyRequired()Returns the original value of the option's required attribute, regardless of whether the option is used in an exclusive group or not.java.util.List<java.lang.String>originalStringValues()Returns the original command line arguments matched by this option or positional parameter spec.CommandLine.IParameterConsumerparameterConsumer()Returns a customIParameterConsumerto temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, ornull.java.lang.StringparamLabel()Returns the name of the option or positional parameter used in the usage help message.CommandLine.IParameterPreprocessorpreprocessor()Returns a customIParameterPreprocessorto either replace or complement picocli's parsing logic for the parameter(s) of this option or position.java.lang.Stringprompt()Returns the text displayed to the end user for an interactive option or positional parameter when asking for user input.java.lang.String[]renderedDescription()Deprecated.Usedescription()insteadbooleanrequired()Returns whether this is a required option or positional parameter without a default value.protected voidresetOriginalStringValues()Sets theoriginalStringValuesto a new list instance.protected voidresetStringValues()Sets thestringValuesto a new list instance.CommandLine.Model.ArgSpecroot()Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; ornullif it was not.CommandLine.Model.IScopescope()Returns the bindingCommandLine.Model.IScopethat determines on which object to set the value (or from which object to get the value) of this argument.CommandLine.ScopeTypescopeType()Returns the scope of this argument; is it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).CommandLine.Model.ISettersetter()Returns theCommandLine.Model.ISetterthat is responsible for modifying the value of this argument.<T> TsetValue(T newValue)Sets the value of this argument to the specified value and returns the previous value.<T> TsetValue(T newValue, CommandLine commandLine)Deprecated.usesetValue(Object)instead.CommandLine.Help.VisibilityshowDefaultValue()Returns whether this option or positional parameter's default value should be shown in the usage help.java.lang.StringsplitRegex()Returns a regular expression to split option parameter values or""if the value should not be split.java.lang.StringsplitRegexSynopsisLabel()Returns a regular expression to split option parameter for usage information.java.util.List<java.lang.String>stringValues()Returns the untyped command line arguments matched by this option or positional parameter spec.java.lang.StringtoString()Returns a string respresentation of this option or positional parameter.java.lang.Class<?>type()Returns the type to convert the option or positional parameter to before setting the value.java.util.List<java.lang.Object>typedValues()Returns the typed command line arguments matched by this option or positional parameter spec.CommandLine.Model.ITypeInfotypeInfo()Returns theITypeInfothat can be used both at compile time (by annotation processors) and at runtime.java.lang.ObjectuserObject()Returns the user object associated with this option or positional parameters.
-
-
-
Field Detail
-
typeInfo
protected final CommandLine.Model.ITypeInfo typeInfo
-
valueIsDefaultValue
protected boolean valueIsDefaultValue
-
annotatedElement
protected final CommandLine.Model.IAnnotatedElement annotatedElement
-
toString
protected java.lang.String toString
-
-
Method Detail
-
originallyRequired
public boolean originallyRequired()
Returns the original value of the option's required attribute, regardless of whether the option is used in an exclusive group or not.- Since:
- 4.7.7-SNAPSHOT
- See Also:
CommandLine.Option.required()
-
required
public boolean required()
Returns whether this is a required option or positional parameter without a default value. If this argument is part of a group, this method returns whether this argument is required within the group (so it is not necessarily a required argument for the command).- See Also:
CommandLine.Option.required()
-
interactive
public boolean interactive()
Returns whether this option will prompt the user to enter a value on the command line.
-
echo
public boolean echo()
Returns whether the user input is echoed to the console or not for an interactive option or positional parameter when asking for user input.- Since:
- 4.6
- See Also:
CommandLine.Option.echo(),CommandLine.Parameters.echo()
-
prompt
public java.lang.String prompt()
Returns the text displayed to the end user for an interactive option or positional parameter when asking for user input.- Since:
- 4.6
- See Also:
CommandLine.Option.prompt(),CommandLine.Parameters.prompt()
-
description
public java.lang.String[] description()
Returns the description of this option or positional parameter, after all variables have been rendered, including the${DEFAULT-VALUE}and${COMPLETION-CANDIDATES}variables. UseCommandLine.Model.CommandSpec.interpolateVariables(Boolean)to switch off variable expansion if needed.If a resource bundle has been set, this method will first try to find a value in the resource bundle: If the resource bundle has no entry for the
fully qualified commandName + "." + descriptionKeyor for the unqualifieddescriptionKey, an attempt is made to find the option or positional parameter description using any of the additional description keys, first with thefully qualified commandName + "."prefix, then without.
-
getAdditionalDescriptionKeys
protected abstract java.util.Collection<java.lang.String> getAdditionalDescriptionKeys()
Subclasses should override to return a collection of additional description keys that may be used to find description text for this option or positional parameter in the resource bundle.
-
descriptionKey
public java.lang.String descriptionKey()
Returns the description key of this arg spec, used to get the description from a resource bundle.- Since:
- 3.6
- See Also:
CommandLine.Option.descriptionKey(),CommandLine.Parameters.descriptionKey()
-
renderedDescription
@Deprecated public java.lang.String[] renderedDescription()
Deprecated.Usedescription()instead
-
arity
public CommandLine.Range arity()
Returns how many arguments this option or positional parameter requires.- See Also:
CommandLine.Option.arity()
-
paramLabel
public java.lang.String paramLabel()
Returns the name of the option or positional parameter used in the usage help message.
-
hideParamSyntax
public boolean hideParamSyntax()
Returns whether usage syntax decorations around the paramLabel should be suppressed. The default isfalse: by default, the paramLabel is surrounded with'['and']'characters if the value is optional and followed by ellipses ("...") when multiple values can be specified.- Since:
- 3.6.0
-
auxiliaryTypes
public java.lang.Class<?>[] auxiliaryTypes()
Returns auxiliary type information used when thetype()is a generic type likeCollection,MaporOptional; returns the concrete type whentype()is an abstract class, otherwise, returns the same astype().- See Also:
CommandLine.Option.type()
-
converters
public CommandLine.ITypeConverter<?>[] converters()
Returns one or moretype convertersto use to convert the command line argument into a strongly typed value (or key-value pair for map fields). This is useful when a particular option or positional parameter should use a custom conversion that is different from the normal conversion for the arg spec's type.- See Also:
CommandLine.Option.converter()
-
splitRegex
public java.lang.String splitRegex()
Returns a regular expression to split option parameter values or""if the value should not be split.- See Also:
CommandLine.Option.split()
-
splitRegexSynopsisLabel
public java.lang.String splitRegexSynopsisLabel()
Returns a regular expression to split option parameter for usage information.- Since:
- 4.3
- See Also:
CommandLine.Option.splitSynopsisLabel()
-
hidden
public boolean hidden()
Returns whether this option should be excluded from the usage message.- See Also:
CommandLine.Option.hidden()
-
inherited
public boolean inherited()
Returns whether this option is inherited from a parent command.- Since:
- 4.3.0
- See Also:
CommandLine.Option.scope()
-
root
public CommandLine.Model.ArgSpec root()
Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; ornullif it was not.- Since:
- 4.6.0
- See Also:
CommandLine.Option.scope()
-
type
public java.lang.Class<?> type()
Returns the type to convert the option or positional parameter to before setting the value. This may be a container type likeList,Map, orOptional, in which case the type or types of the elements are returned byauxiliaryTypes().
-
typeInfo
public CommandLine.Model.ITypeInfo typeInfo()
Returns theITypeInfothat can be used both at compile time (by annotation processors) and at runtime.- Since:
- 4.0
-
userObject
public java.lang.Object userObject()
Returns the user object associated with this option or positional parameters.- Returns:
- may return the annotated program element, or some other useful object
- Since:
- 4.0
-
mapFallbackValue
public java.lang.String mapFallbackValue()
Returns the fallback value for this Map option or positional parameter: the value that is put into the Map when only the key is specified for the option or positional parameter, like-Dkeyinstead of-Dkey=value.If no
mapFallbackValueis set, key-only Map parameters like-Dkeyare considered invalid user input and cause aCommandLine.ParameterExceptionto be thrown.By default, this method returns a special "__unspecified__" value indicating that no
mapFallbackValuewas set.- Since:
- 4.6
- See Also:
CommandLine.Option.mapFallbackValue(),CommandLine.Parameters.mapFallbackValue()
-
defaultValue
public java.lang.String defaultValue()
Returns the default value to assign if this option or positional parameter was not specified on the command line, before splitting and type conversion. This method returns the programmatically set value; this may differ from the default value that is actually used: if this ArgSpec is part of a CommandSpec with aCommandLine.IDefaultValueProvider, picocli will first try to obtain the default value from the default value provider, and this method is only called if the default provider isnullor returned anullvalue.- Returns:
- the programmatically set default value of this option/positional parameter,
returning
nullmeans this option or positional parameter does not have a default - See Also:
CommandLine.Model.CommandSpec.defaultValueProvider(),CommandLine.Model.OptionSpec.fallbackValue()
-
initialValue
public java.lang.Object initialValue()
Returns the initial value of this option or positional parameter: the value that, ifhasInitialValue()is true, the option will be reset to before parsing (regardless of whether a default value exists), to clear values that would otherwise remain from parsing previous input.
-
hasInitialValue
public boolean hasInitialValue()
Determines whether the option or positional parameter will be reset to theinitialValue()before parsing new input.
-
showDefaultValue
public CommandLine.Help.Visibility showDefaultValue()
Returns whether this option or positional parameter's default value should be shown in the usage help.
-
defaultValueString
public java.lang.String defaultValueString()
Returns the default value String for the purpose of displaying it in the description, without interpolating variables.- See Also:
defaultValueString(boolean)
-
defaultValueString
public java.lang.String defaultValueString(boolean interpolateVariables)
Returns the default value String displayed in the description; interpolating variables if specified. If this ArgSpec is part of a CommandSpec with aCommandLine.IDefaultValueProvider, this method will first try to obtain the default value from the default value provider; if the provider isnullor if it returns anullvalue, then next any value set todefaultValue()is returned, and if this is alsonull, finally the initial value is returned.- Parameters:
interpolateVariables- whether to interpolate variables in thedefaultValueattribute of this ArgSpec- Since:
- 4.0
- See Also:
CommandLine.Model.CommandSpec.defaultValueProvider(),defaultValue()
-
completionCandidates
public java.lang.Iterable<java.lang.String> completionCandidates()
Returns the explicitly set completion candidates for this option or positional parameter, valid enum constant names, ornullif this option or positional parameter does not have any completion candidates and its type is not an enum.- Returns:
- the completion candidates for this option or positional parameter, valid enum constant names,
or
null - Since:
- 3.2
-
parameterConsumer
public CommandLine.IParameterConsumer parameterConsumer()
Returns a customIParameterConsumerto temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, ornull. An example of when this may be useful is when passing arguments through to another program.- Since:
- 4.0
-
preprocessor
public CommandLine.IParameterPreprocessor preprocessor()
Returns a customIParameterPreprocessorto either replace or complement picocli's parsing logic for the parameter(s) of this option or position.- Since:
- 4.6
-
getter
public CommandLine.Model.IGetter getter()
Returns theCommandLine.Model.IGetterthat is responsible for supplying the value of this argument.
-
setter
public CommandLine.Model.ISetter setter()
Returns theCommandLine.Model.ISetterthat is responsible for modifying the value of this argument.
-
scope
public CommandLine.Model.IScope scope()
Returns the bindingCommandLine.Model.IScopethat determines on which object to set the value (or from which object to get the value) of this argument.
-
scopeType
public CommandLine.ScopeType scopeType()
Returns the scope of this argument; is it local, or inherited (it applies to this command as well as all sub- and sub-subcommands).- Returns:
- whether this argument applies to all descendent subcommands of the command where it is defined
- Since:
- 4.3
-
isValueGettable
public boolean isValueGettable()
Check whether thegetValue()method is able to get an actual value from the currentgetter().- Since:
- 4.7
-
getValue
public <T> T getValue() throws CommandLine.PicocliExceptionReturns the current value of this argument. Delegates to the currentgetter().- Throws:
CommandLine.PicocliException
-
setValue
public <T> T setValue(T newValue) throws CommandLine.PicocliExceptionSets the value of this argument to the specified value and returns the previous value. Delegates to the currentsetter().- Throws:
CommandLine.PicocliException
-
setValue
@Deprecated public <T> T setValue(T newValue, CommandLine commandLine) throws CommandLine.PicocliExceptionDeprecated.usesetValue(Object)instead. This was a design mistake.Sets the value of this argument to the specified value and returns the previous value. Delegates to the currentsetter().- Throws:
CommandLine.PicocliException- Since:
- 3.5
-
isMultiValue
public boolean isMultiValue()
-
isOption
public abstract boolean isOption()
Returnstrueif this argument is a named option,falseotherwise.
-
isPositional
public abstract boolean isPositional()
Returnstrueif this argument is a positional parameter,falseotherwise.
-
group
public CommandLine.Model.ArgGroupSpec group()
Returns the groups this option or positional parameter belongs to, ornullif this option is not part of a group.- Since:
- 4.0
-
command
public CommandLine.Model.CommandSpec command()
Returns the command this option or positional parameter belongs to.Beware that it is possible to programmatically add an option or positional parameter to more than one command model. (This will not happen in models that are auto-generated from annotations). In that case this method will only return the one it was added to last.
If the option or positional parameter has not yet been attached to a command,
nullwill be returned.- Since:
- 4.1
-
stringValues
public java.util.List<java.lang.String> stringValues()
Returns the untyped command line arguments matched by this option or positional parameter spec.- Returns:
- the matched arguments after splitting, but before type conversion.
For map properties,
"key=value"values are split into the key and the value part.
-
typedValues
public java.util.List<java.lang.Object> typedValues()
Returns the typed command line arguments matched by this option or positional parameter spec.- Returns:
- the matched arguments after splitting and type conversion.
For map properties,
"key=value"values are split into the key and the value part.
-
resetStringValues
protected void resetStringValues()
Sets thestringValuesto a new list instance.
-
originalStringValues
public java.util.List<java.lang.String> originalStringValues()
Returns the original command line arguments matched by this option or positional parameter spec.- Returns:
- the matched arguments as found on the command line: empty Strings for options without value, the
values have not been split, and for map properties values may look like
"key=value"
-
resetOriginalStringValues
protected void resetOriginalStringValues()
Sets theoriginalStringValuesto a new list instance.
-
internalShowDefaultValue
protected boolean internalShowDefaultValue(boolean usageHelpShowDefaults)
Returns whether the default for this option or positional parameter should be shown, potentially overriding the specified global setting.- Parameters:
usageHelpShowDefaults- whether the command's UsageMessageSpec is configured to show default values.
-
messages
public CommandLine.Model.Messages messages()
Returns the Messages for this arg specification, ornull.- Since:
- 3.6
-
messages
public CommandLine.Model.ArgSpec messages(CommandLine.Model.Messages msgs)
Sets the Messages for this ArgSpec, and returns this ArgSpec.- Parameters:
msgs- the new Messages value, may benull- Since:
- 3.6
- See Also:
CommandLine.Command.resourceBundle(),description(),description()
-
toString
public java.lang.String toString()
Returns a string respresentation of this option or positional parameter.- Overrides:
toStringin classjava.lang.Object
-
equalsImpl
protected boolean equalsImpl(CommandLine.Model.ArgSpec other)
-
hashCodeImpl
protected int hashCodeImpl()
-
-