Package picocli

Class CommandLine.Model.OptionSpec.Builder

  • Enclosing class:
    CommandLine.Model.OptionSpec

    public static class CommandLine.Model.OptionSpec.Builder
    extends Object
    Builder responsible for creating valid OptionSpec objects.
    Since:
    3.0
    • Method Detail

      • versionHelp

        public boolean versionHelp()
        Returns whether this option allows the user to request version information.
        See Also:
        CommandLine.Option.versionHelp()
      • fallbackValue

        public String fallbackValue()
        Returns the fallback value for this option: the value that is assigned for options with an optional parameter if the option was specified on the command line without parameter.
        Since:
        4.0
        See Also:
        CommandLine.Option.fallbackValue()
      • names

        public CommandLine.Model.OptionSpec.Builder names​(String... names)
        Replaces the option names with the specified values. At least one option name is required, and returns this builder.
        Returns:
        this builder instance to provide a fluent interface
      • usageHelp

        public CommandLine.Model.OptionSpec.Builder usageHelp​(boolean usageHelp)
        Sets whether this option allows the user to request usage help, and returns this builder.
      • versionHelp

        public CommandLine.Model.OptionSpec.Builder versionHelp​(boolean versionHelp)
        Sets whether this option allows the user to request version information, and returns this builder.
      • negatable

        public CommandLine.Model.OptionSpec.Builder negatable​(boolean negatable)
        Sets whether a negative version for this boolean option is automatically added, and returns this builder.
        Since:
        4.0
      • order

        public CommandLine.Model.OptionSpec.Builder order​(int order)
        Sets the position in the options list in the usage help message at which this option should be shown, and returns this builder.
        Since:
        3.9
      • required

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

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

        public T description​(String... description)
        Sets the description of this option, used when generating the usage documentation, and returns this builder.
        See Also:
        CommandLine.Option.description()
      • 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 Collection or a Map; 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.
      • 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
      • hidden

        public T hidden​(boolean hidden)
        Sets whether this option should be excluded from the usage message, and returns this builder.
      • 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
      • 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
      • 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.
      • withToString

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