Module info.picocli
Package picocli

Class CommandLine.Model.ArgSpec

    • 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.0
        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()
      • hideParamSyntax

        public boolean hideParamSyntax()
        Returns whether usage syntax decorations around the paramLabel should be suppressed. The default is false: 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 Class<?>[] auxiliaryTypes()
        Returns auxiliary type information used when the type() is a generic type like Collection, Map or Optional; returns the concrete type when type() is an abstract class, otherwise, returns the same as type().
        See Also:
        CommandLine.Option.type()
      • converters

        public CommandLine.ITypeConverter<?>[] converters()
        Returns one or more type converters to 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 String splitRegex()
        Returns a regular expression to split option parameter values or "" if the value should not be split.
        See Also:
        CommandLine.Option.split()
      • 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()
      • type

        public Class<?> type()
        Returns the type to convert the option or positional parameter to before setting the value. This may be a container type like List, Map, or Optional, in which case the type or types of the elements are returned by auxiliaryTypes().
      • typeInfo

        public CommandLine.Model.ITypeInfo typeInfo()
        Returns the ITypeInfo that can be used both at compile time (by annotation processors) and at runtime.
        Since:
        4.0
      • userObject

        public 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 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 -Dkey instead of -Dkey=value.

        If no mapFallbackValue is set, key-only Map parameters like -Dkey are considered invalid user input and cause a CommandLine.ParameterException to be thrown.

        By default, this method returns a special "__unspecified__" value indicating that no mapFallbackValue was set.

        Since:
        4.6
        See Also:
        CommandLine.Option.mapFallbackValue(), CommandLine.Parameters.mapFallbackValue()
      • defaultValue

        public 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 a CommandLine.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 is null or returned a null value.
        Returns:
        the programmatically set default value of this option/positional parameter, returning null means this option or positional parameter does not have a default
        See Also:
        CommandLine.Model.CommandSpec.defaultValueProvider(), CommandLine.Model.OptionSpec.fallbackValue()
      • initialValue

        public Object initialValue()
        Returns the initial value of this option or positional parameter: the value that, if hasInitialValue() 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 the initialValue() 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 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 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 a CommandLine.IDefaultValueProvider, this method will first try to obtain the default value from the default value provider; if the provider is null or if it returns a null value, then next any value set to defaultValue() is returned, and if this is also null, finally the initial value is returned.
        Parameters:
        interpolateVariables - whether to interpolate variables in the defaultValue attribute of this ArgSpec
        Since:
        4.0
        See Also:
        CommandLine.Model.CommandSpec.defaultValueProvider(), defaultValue()
      • completionCandidates

        public Iterable<String> completionCandidates()
        Returns the explicitly set completion candidates for this option or positional parameter, valid enum constant names, or null if 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 custom IParameterConsumer to temporarily suspend picocli's parsing logic and process one or more command line arguments in a custom manner, or null. 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 custom IParameterPreprocessor to either replace or complement picocli's parsing logic for the parameter(s) of this option or position.
        Since:
        4.6
      • scopeType

        public CommandLine.ScopeType scopeType()
        Returns the scope of this argument; it 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 the getValue() method is able to get an actual value from the current getter().
        Since:
        4.7
      • isMultiValue

        public boolean isMultiValue()
        Returns true if this argument's type() is an array, a Collection or a Map, false otherwise.
      • isOption

        public abstract boolean isOption()
        Returns true if this argument is a named option, false otherwise.
      • isPositional

        public abstract boolean isPositional()
        Returns true if this argument is a positional parameter, false otherwise.
      • group

        public CommandLine.Model.ArgGroupSpec group()
        Returns the groups this option or positional parameter belongs to, or null if 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, null will be returned.

        Since:
        4.1
      • stringValues

        public List<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 List<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 the stringValues to a new list instance.
      • originalStringValues

        public List<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 the originalStringValues to 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.
      • toString

        public String toString()
        Returns a string respresentation of this option or positional parameter.
        Overrides:
        toString in class Object
      • hashCodeImpl

        protected int hashCodeImpl()