Class CommandLine.Model.OptionSpec.Builder

Method Details

• build

  public CommandLine.Model.OptionSpec build()

  Returns a valid OptionSpec instance.

• self

  protected CommandLine.Model.OptionSpec.Builder self()

  Returns this builder.

• names

  public String[] names()

  Returns one or more option names. At least one option name is required.

  See Also:

  • CommandLine.Option.names()

• help

  @Deprecated public boolean help()

  Deprecated.

  Use usageHelp() and versionHelp() instead.

  Returns whether this option disables validation of the other arguments.

  See Also:

  • CommandLine.Option.help()

• usageHelp

  public boolean usageHelp()

  Returns whether this option allows the user to request usage help.

  See Also:

  • CommandLine.Option.usageHelp()

• versionHelp

  public boolean versionHelp()

  Returns whether this option allows the user to request version information.

  See Also:

  • CommandLine.Option.versionHelp()

• negatable

  public boolean negatable()

  Returns whether a negative version for this boolean option is automatically added. The form of the negative name is determined by the CommandLine.INegatableOptionTransformer.

  Since:

  4.0

  See Also:

  • CommandLine.Option.negatable()

• 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()

• order

  public int order()

  Returns the position in the options list in the usage help message at which this option should be shown. Options with a lower number are shown before options with a higher number. This attribute is only honored if CommandLine.Model.UsageMessageSpec.sortOptions() is false for this command.

  Since:

  3.9

  See Also:

  • CommandLine.Option.order()

• 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

• help

  public CommandLine.Model.OptionSpec.Builder help(boolean help)

  Sets whether this option disables validation of the other arguments, and returns this builder.

• 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

• fallbackValue

  public CommandLine.Model.OptionSpec.Builder fallbackValue(String fallbackValue)

  Sets 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, and returns this builder.

  Since:

  4.0

  See Also:

  • CommandLine.Option.fallbackValue()

• 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()

• description

  public String[] description()

  Returns the description of this option, used when generating the usage documentation.

  See Also:

  • CommandLine.Option.description()

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

  • CommandLine.Option.descriptionKey()
  • CommandLine.Parameters.descriptionKey()

• arity

  public CommandLine.Range arity()

  Returns how many arguments this option or positional parameter requires.

  See Also:

  • CommandLine.Option.arity()

• paramLabel

  public String paramLabel()

  Returns the name of the option or positional parameter used in the usage help message.

  See Also:

  • Parameters#paramLabel()

• 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

• 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 where the setter sets the value (or the getter gets the value) of this argument.

• toString

  public String toString()

  Overrides:

  toString in class Object

• required

  public CommandLine.Model.OptionSpec.Builder required(boolean required)

  Sets whether this is a required option or positional parameter, and returns this builder.

• interactive

  public CommandLine.Model.OptionSpec.Builder interactive(boolean interactive)

  Sets whether this option prompts the user to enter a value on the command line, and returns this builder.

• description

  public CommandLine.Model.OptionSpec.Builder description(String... description)

  Sets the description of this option, used when generating the usage documentation, and returns this builder.

  See Also:

  • CommandLine.Option.description()

• descriptionKey

  public CommandLine.Model.OptionSpec.Builder 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:

  • CommandLine.Option.descriptionKey()
  • CommandLine.Parameters.descriptionKey()

• arity

  public CommandLine.Model.OptionSpec.Builder arity(String range)

  Sets how many arguments this option or positional parameter requires, and returns this builder.

• arity

  public CommandLine.Model.OptionSpec.Builder arity(CommandLine.Range arity)

  Sets how many arguments this option or positional parameter requires, and returns this builder.

• paramLabel

  public CommandLine.Model.OptionSpec.Builder paramLabel(String paramLabel)

  Sets the name of the option or positional parameter used in the usage help message, and returns this builder.

• hideParamSyntax

  public CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder converters(CommandLine.ITypeConverter<?>... cs)

  Sets option/positional param-specific converter (or converters for Maps), and returns this builder.

• splitRegex

  public CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder completionCandidates(Iterable<String> completionCandidates)

  Sets the completion candidates for this option or positional parameter, and returns this builder.

  Since:

  3.2

• parameterConsumer

  public CommandLine.Model.OptionSpec.Builder parameterConsumer(CommandLine.IParameterConsumer parameterConsumer)

  Sets the parameterConsumer for this option or positional parameter, and returns this builder.

  Since:

  4.0

• hidden

  public CommandLine.Model.OptionSpec.Builder hidden(boolean hidden)

  Sets whether this option should be excluded from the usage message, and returns this builder.

• type

  public CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder hasInitialValue(boolean hasInitialValue)

  Determines whether the option or positional parameter will be reset to the initialValue() before parsing new input.

• getter

  public CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder 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 CommandLine.Model.OptionSpec.Builder scope(CommandLine.Model.IScope scope)

  Sets the CommandLine.Model.IScope that targets where the setter sets the value, and returns this builder.

• withToString

  public CommandLine.Model.OptionSpec.Builder withToString(String toString)

  Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.