Package picocli

Class CommandLine.Model.ArgSpec.Builder<T extends CommandLine.Model.ArgSpec.Builder<T>>

java.lang.Object
picocli.CommandLine.Model.ArgSpec.Builder<T>
Direct Known Subclasses:
CommandLine.Model.OptionSpec.Builder, CommandLine.Model.PositionalParamSpec.Builder
Enclosing class:
CommandLine.Model.ArgSpec

abstract static class CommandLine.Model.ArgSpec.Builder<T extends CommandLine.Model.ArgSpec.Builder<T>> extends Object
  • Field Details

  • Constructor Details

  • Method Details

    • inferLabel

      private static String inferLabel(String label, CommandLine.Model.IAnnotatedElement annotatedElement)
    • build

      public abstract CommandLine.Model.ArgSpec build()
    • self

      protected abstract T self()
    • required

      public boolean required()
      Returns whether this is a required option or positional parameter.
      See Also:
    • interactive

      public boolean interactive()
      Returns whether this option prompts the user to enter a value on the command line.
      See Also:
    • 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:
    • prompt

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

      public String[] description()
      Returns the description of this option, used when generating the usage documentation.
      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:
    • 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 container like Collection, Map, Optional 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:
    • splitRegexSynopsisLabel

      public String splitRegexSynopsisLabel()
      Returns a regular expression to split option parameter for usage information.
      Since:
      4.3
      See Also:
    • hidden

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

      public boolean inherited()
      Returns whether this option is inherited from a parent command.
      Since:
      4.3.0
      See Also:
    • root

      Returns the root option or positional parameter (on the parent command), if this option or positional parameter was inherited; or null if it was not.
      Since:
      4.6.0
      See Also:
    • 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 type info for this option or positional parameter.
      Returns:
      type information that does not require Class objects and be constructed both at runtime and compile time
      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:
    • defaultValue

      public String defaultValue()
      Returns the default value of this option or positional parameter, before splitting and type conversion. A value of null means this option or positional parameter does not have a default.
    • 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.
    • completionCandidates

      public Iterable<String> completionCandidates()
      Returns the completion candidates for this option or positional parameter, or null.
      Since:
      3.2
    • parameterConsumer

      public CommandLine.IParameterConsumer parameterConsumer()
      Returns the custom parameter handler for this option or positional parameter, or null.
      Since:
      4.0
    • preprocessor

      public CommandLine.IParameterPreprocessor preprocessor()
      Returns the custom IParameterPreprocessor to either replace or complement picocli's parsing logic for the parameter(s) of this option or position, or null.
      Since:
      4.6
    • 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 binding CommandLine.Model.IScope that determines the instance of the enclosing element where the setter sets the value (or the getter gets the value) of this argument.
    • scopeType

      public CommandLine.ScopeType scopeType()
      Returns the scope of this argument.
      Returns:
      whether this argument applies to all descendent subcommands of the command where it is defined
      Since:
      4.3
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • required

      public T required(boolean required)
      Sets whether this is a required option or positional parameter, and returns this builder.
    • interactive

      public T interactive(boolean interactive)
      Sets whether this option prompts the user to enter a value on the command line, and returns this builder.
    • echo

      public T echo(boolean echo)
      Sets whether the user input is echoed to the console or not for an interactive option or positional parameter.
    • prompt

      public T prompt(String prompt)
      Sets the text displayed to the end user for an interactive option or positional parameter when asking for user input.
    • description

      public T description(String... description)
      Sets the description of this option, used when generating the usage documentation, and returns this builder.
      See Also:
    • descriptionKey

      public T descriptionKey(String descriptionKey)
      Sets the description key that is used to look up the description in a resource bundle, and returns this builder.
      Since:
      3.6
      See Also:
    • arity

      public T arity(String range)
      Sets how many arguments this option or positional parameter requires, and returns this builder.
    • arity

      public T arity(CommandLine.Range arity)
      Sets how many arguments this option or positional parameter requires, and returns this builder.
    • paramLabel

      public T paramLabel(String paramLabel)
      Sets the name of the option or positional parameter used in the usage help message, and returns this builder.
    • hideParamSyntax

      public T hideParamSyntax(boolean hideParamSyntax)
      Sets 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 T auxiliaryTypes(Class<?>... types)
      Sets auxiliary type information, and returns this builder.
      Parameters:
      types - the element type(s) when the type() is a generic type like Collection, Map or Optional; or the concrete type when the type() is an abstract class.
    • converters

      public T converters(CommandLine.ITypeConverter<?>... cs)
      Sets option/positional param-specific converter (or converters for Maps), and returns this builder.
    • splitRegex

      public T splitRegex(String splitRegex)
      Sets a regular expression to split option parameter values or "" if the value should not be split, and returns this builder.
    • splitRegexSynopsisLabel

      public T splitRegexSynopsisLabel(String splitRegexSynopsisLabel)
      Sets a regular expression to split option parameter for usage information.
    • showDefaultValue

      public T showDefaultValue(CommandLine.Help.Visibility visibility)
      Sets whether this option or positional parameter's default value should be shown in the usage help, and returns this builder.
    • completionCandidates

      public T completionCandidates(Iterable<String> completionCandidates)
      Sets the completion candidates for this option or positional parameter, and returns this builder.
      Since:
      3.2
    • parameterConsumer

      public T parameterConsumer(CommandLine.IParameterConsumer parameterConsumer)
      Sets the parameterConsumer for this option or positional parameter, and returns this builder.
      Since:
      4.0
    • preprocessor

      public T preprocessor(CommandLine.IParameterPreprocessor preprocessor)
      Sets the custom IParameterPreprocessor for this option or position, and returns this builder.
      Since:
      4.6
    • hidden

      public T hidden(boolean hidden)
      Sets whether this option should be excluded from the usage message, and returns this builder.
    • inherited

      public T inherited(boolean inherited)
      Sets whether this option is inherited from a parent command, and returns this builder.
      Since:
      4.3.0
    • root

      public T root(CommandLine.Model.ArgSpec root)
      Sets the root object for this inherited option, and returns this builder.
      Since:
      4.6.0
    • type

      public T type(Class<?> propertyType)
      Sets the type to convert the option or positional parameter to before setting the value, and returns this builder.
      Parameters:
      propertyType - the type of this option or parameter. For multi-value options and positional parameters this can be an array, or a (sub-type of) Collection or Map.
    • typeInfo

      public T typeInfo(CommandLine.Model.ITypeInfo typeInfo)
      Sets the type info for this option or positional parameter, and returns this builder.
      Parameters:
      typeInfo - type information that does not require Class objects and be constructed both at runtime and compile time
      Since:
      4.0
    • setTypeInfo

      private void setTypeInfo(CommandLine.Model.ITypeInfo newValue)
    • userObject

      public T userObject(Object userObject)
      Sets the user object associated with this option or positional parameters, and returns this builder.
      Parameters:
      userObject - may be the annotated program element, or some other useful object
      Since:
      4.0
    • mapFallbackValue

      public CommandLine.Model.ArgSpec.Builder mapFallbackValue(String fallbackValue)
      Sets 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.

      Since:
      4.6
      See Also:
    • defaultValue

      public T defaultValue(String defaultValue)
      Sets the default value of this option or positional parameter to the specified value, and returns this builder. Before parsing the command line, the result of splitting and type converting this default value is applied to the option or positional parameter. A value of null or "__no_default_value__" means no default.
    • initialValue

      public T initialValue(Object initialValue)
      Sets the initial value of this option or positional parameter to the specified value, and returns this builder. 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 T hasInitialValue(boolean hasInitialValue)
      Determines whether the option or positional parameter will be reset to the initialValue() before parsing new input.
    • getter

      public T getter(CommandLine.Model.IGetter getter)
      Sets the CommandLine.Model.IGetter that is responsible for getting the value of this argument, and returns this builder.
    • setter

      public T setter(CommandLine.Model.ISetter setter)
      Sets the CommandLine.Model.ISetter that is responsible for modifying the value of this argument, and returns this builder.
    • scope

      public T scope(CommandLine.Model.IScope scope)
      Sets the binding CommandLine.Model.IScope that targets where the setter sets the value, and returns this builder.
    • scopeType

      public T scopeType(CommandLine.ScopeType scopeType)
      Sets the scope of where this argument applies: only this command, or also all sub (and sub-sub) commands, and returns this builder.
      Since:
      4.3
    • withToString

      public T withToString(String toString)
      Sets the string representation of this option or positional parameter to the specified value, and returns this builder.