Package nz.org.riskscape.picocli

Class CommandLine.Model.ArgSpec

java.lang.Object
nz.org.riskscape.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 Object
Models the shared attributes of CommandLine.Model.OptionSpec and CommandLine.Model.PositionalParamSpec.
Since:
3.0

  • Field Details

    • toString

      protected String toString

  • Method Details

    • 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:

    • interactive

      public boolean interactive()
      Returns whether this option will prompt the user to enter a value on the command line.
      See Also:

    • description

      public 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. Use CommandLine.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 + "." + descriptionKey or for the unqualified descriptionKey, an attempt is made to find the option or positional parameter description using any of the additional description keys, first with the fully qualified commandName + "." prefix, then without.

      See Also:

    • getAdditionalDescriptionKeys

      protected abstract Collection<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.
      Since:
      4.0
      See Also:

    • descriptionKey

      public String descriptionKey()
      Returns the description key of this arg spec, used to get the description from a resource bundle.
      Since:
      3.6
      See Also:

    • renderedDescription

      @Deprecated public String[] renderedDescription()
      Deprecated.
      Use description() instead

    • arity

      public CommandLine.Range arity()
      Returns how many arguments this option or positional parameter requires.
      See Also:

    • paramLabel

      public String paramLabel()
      Returns the name of the option or positional parameter used in the usage help message.
      See Also:

    • 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 Collection, Map or an abstract class.
      See Also:

    • 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:

    • splitRegex

      public String splitRegex()
      Returns a regular expression to split option parameter values or "" if the value should not be split.
      See Also:

    • hidden

      public boolean hidden()
      Returns whether this option should be excluded from the usage message.
      See Also:

    • type

      public Class<?> type()
      Returns the type to convert the option or positional parameter to before setting the value.

    • 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

    • 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:

    • initialValue

      public Object initialValue()
      Returns the initial value this option or positional parameter. If hasInitialValue() is true, the option will be reset to the initial value 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

      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:

    • 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

    • getter

      public CommandLine.Model.IGetter getter()
      Returns the CommandLine.Model.IGetter that is responsible for supplying the value of this argument.

    • setter

      public CommandLine.Model.ISetter setter()
      Returns the CommandLine.Model.ISetter that is responsible for modifying the value of this argument.

    • scope

      public CommandLine.Model.IScope scope()
      Returns the CommandLine.Model.IScope that determines on which object to set the value (or from which object to get the value) of this argument.

    • getValue

      public <T> T getValue() throws CommandLine.PicocliException
      Returns the current value of this argument. Delegates to the current getter().
      Throws:
      CommandLine.PicocliException

    • setValue

      public <T> T setValue(T newValue) throws CommandLine.PicocliException
      Sets the value of this argument to the specified value and returns the previous value. Delegates to the current setter().
      Throws:
      CommandLine.PicocliException

    • setValue

      @Deprecated public <T> T setValue(T newValue, CommandLine commandLine) throws CommandLine.PicocliException
      Deprecated.
      use setValue(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 current setter().
      Throws:
      CommandLine.PicocliException
      Since:
      3.5

    • 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.

    • messages

      public CommandLine.Model.Messages messages()
      Returns the Messages for this arg specification, or null.
      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 be null
      Since:
      3.6
      See Also:

    • toString

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

    • equalsImpl

      protected boolean equalsImpl(CommandLine.Model.ArgSpec other)

    • hashCodeImpl

      protected int hashCodeImpl()