public static class CommandLine.Model.PositionalParamSpec.Builder
extends java.lang.Object
PositionalParamSpec
objects.Modifier and Type | Method and Description |
---|---|
CommandLine.Range |
arity()
Returns how many arguments this option or positional parameter requires.
|
T |
arity(CommandLine.Range arity)
Sets how many arguments this option or positional parameter requires, and returns this builder.
|
T |
arity(java.lang.String range)
Sets how many arguments this option or positional parameter requires, and returns this builder.
|
java.lang.Class<?>[] |
auxiliaryTypes()
Returns auxiliary type information used when the
type() is a generic Collection , Map or an abstract class. |
T |
auxiliaryTypes(java.lang.Class<?>... types)
Sets auxiliary type information, and returns this builder.
|
CommandLine.Model.PositionalParamSpec |
build()
Returns a valid
PositionalParamSpec instance. |
java.lang.Iterable<java.lang.String> |
completionCandidates()
Returns the completion candidates for this option or positional parameter, or
null . |
T |
completionCandidates(java.lang.Iterable<java.lang.String> completionCandidates)
Sets the completion candidates for this option or positional parameter, and returns this builder.
|
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). |
T |
converters(CommandLine.ITypeConverter<?>... cs)
Sets option/positional param-specific converter (or converters for Maps), and returns this builder.
|
java.lang.String |
defaultValue()
Returns the default value of this option or positional parameter, before splitting and type conversion.
|
T |
defaultValue(java.lang.String defaultValue)
Sets the default value of this option or positional parameter to the specified value, and returns this builder.
|
java.lang.String[] |
description()
Returns the description of this option, used when generating the usage documentation.
|
T |
description(java.lang.String... description)
Sets the description of this option, used when generating the usage documentation, and returns this builder.
|
java.lang.String |
descriptionKey()
Returns the description key of this arg spec, used to get the description from a resource bundle.
|
T |
descriptionKey(java.lang.String descriptionKey)
Sets the description key that is used to look up the description in a resource bundle, and returns this builder.
|
CommandLine.Model.IGetter |
getter()
Returns the
CommandLine.Model.IGetter that is responsible for supplying the value of this argument. |
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. |
boolean |
hasInitialValue()
Determines whether the option or positional parameter will be reset to the
initialValue()
before parsing new input. |
T |
hasInitialValue(boolean hasInitialValue)
Determines whether the option or positional parameter will be reset to the
initialValue()
before parsing new input. |
boolean |
hidden()
Returns whether this option should be excluded from the usage message.
|
T |
hidden(boolean hidden)
Sets whether this option should be excluded from the usage message, and returns this builder.
|
boolean |
hideParamSyntax()
Returns whether usage syntax decorations around the paramLabel should be suppressed.
|
T |
hideParamSyntax(boolean hideParamSyntax)
Sets whether usage syntax decorations around the paramLabel should be suppressed.
|
CommandLine.Range |
index()
Returns an index or range specifying which of the command line arguments should be assigned to this positional parameter.
|
CommandLine.Model.PositionalParamSpec.Builder |
index(CommandLine.Range index)
Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.
|
CommandLine.Model.PositionalParamSpec.Builder |
index(java.lang.String range)
Sets the index or range specifying which of the command line arguments should be assigned to this positional parameter, and returns this builder.
|
java.lang.Object |
initialValue()
Returns the initial value this option or positional parameter.
|
T |
initialValue(java.lang.Object initialValue)
Sets the initial value of this option or positional parameter to the specified value, and returns this builder.
|
boolean |
interactive()
Returns whether this option prompts the user to enter a value on the command line.
|
T |
interactive(boolean interactive)
Sets whether this option prompts the user to enter a value on the command line, and returns this builder.
|
java.lang.String |
paramLabel()
Returns the name of the option or positional parameter used in the usage help message.
|
T |
paramLabel(java.lang.String paramLabel)
Sets the name of the option or positional parameter used in the usage help message, and returns this builder.
|
boolean |
required()
Returns whether this is a required option or positional parameter.
|
T |
required(boolean required)
Sets whether this is a required option or positional parameter, and returns this builder.
|
protected CommandLine.Model.PositionalParamSpec.Builder |
self()
Returns this builder.
|
CommandLine.Model.ISetter |
setter()
Returns the
CommandLine.Model.ISetter that is responsible for modifying the value of this argument. |
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. |
CommandLine.Help.Visibility |
showDefaultValue()
Returns whether this option or positional parameter's default value should be shown in the usage help.
|
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.
|
java.lang.String |
splitRegex()
Returns a regular expression to split option parameter values or
"" if the value should not be split. |
T |
splitRegex(java.lang.String splitRegex)
Sets a regular expression to split option parameter values or
"" if the value should not be split, and returns this builder. |
java.lang.String |
toString() |
java.lang.Class<?> |
type()
Returns the type to convert the option or positional parameter to before setting the value.
|
T |
type(java.lang.Class<?> propertyType)
Sets the type to convert the option or positional parameter to before setting the value, and returns this builder.
|
T |
withToString(java.lang.String toString)
Sets the string respresentation of this option or positional parameter to the specified value, and returns this builder.
|
public CommandLine.Model.PositionalParamSpec build()
PositionalParamSpec
instance.protected CommandLine.Model.PositionalParamSpec.Builder self()
public CommandLine.Range index()
CommandLine.Parameters.index()
public CommandLine.Model.PositionalParamSpec.Builder index(java.lang.String range)
public CommandLine.Model.PositionalParamSpec.Builder index(CommandLine.Range index)
public boolean required()
CommandLine.Option.required()
public boolean interactive()
CommandLine.Option.interactive()
public java.lang.String[] description()
CommandLine.Option.description()
public java.lang.String descriptionKey()
CommandLine.Option.descriptionKey()
,
CommandLine.Parameters.descriptionKey()
public CommandLine.Range arity()
CommandLine.Option.arity()
public java.lang.String paramLabel()
{@link Parameters#paramLabel()}
public boolean hideParamSyntax()
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.public java.lang.Class<?>[] auxiliaryTypes()
type()
is a generic Collection
, Map
or an abstract class.CommandLine.Option.type()
public CommandLine.ITypeConverter<?>[] converters()
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.CommandLine.Option.converter()
public java.lang.String splitRegex()
""
if the value should not be split.CommandLine.Option.split()
public boolean hidden()
CommandLine.Option.hidden()
public java.lang.Class<?> type()
public java.lang.String defaultValue()
null
means this option or positional parameter does not have a default.public java.lang.Object initialValue()
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.public boolean hasInitialValue()
initialValue()
before parsing new input.public CommandLine.Help.Visibility showDefaultValue()
public java.lang.Iterable<java.lang.String> completionCandidates()
null
.public CommandLine.Model.IGetter getter()
CommandLine.Model.IGetter
that is responsible for supplying the value of this argument.public CommandLine.Model.ISetter setter()
CommandLine.Model.ISetter
that is responsible for modifying the value of this argument.public java.lang.String toString()
toString
in class java.lang.Object
public T required(boolean required)
public T interactive(boolean interactive)
public T description(java.lang.String... description)
CommandLine.Option.description()
public T descriptionKey(java.lang.String descriptionKey)
CommandLine.Option.descriptionKey()
,
CommandLine.Parameters.descriptionKey()
public T arity(java.lang.String range)
public T arity(CommandLine.Range arity)
public T paramLabel(java.lang.String paramLabel)
public T hideParamSyntax(boolean hideParamSyntax)
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.public T auxiliaryTypes(java.lang.Class<?>... types)
public T converters(CommandLine.ITypeConverter<?>... cs)
public T splitRegex(java.lang.String splitRegex)
""
if the value should not be split, and returns this builder.public T showDefaultValue(CommandLine.Help.Visibility visibility)
public T completionCandidates(java.lang.Iterable<java.lang.String> completionCandidates)
public T hidden(boolean hidden)
public T type(java.lang.Class<?> propertyType)
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.public T defaultValue(java.lang.String defaultValue)
null
or "__no_default_value__"
means no default.public T initialValue(java.lang.Object initialValue)
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.public T hasInitialValue(boolean hasInitialValue)
initialValue()
before parsing new input.public T getter(CommandLine.Model.IGetter getter)
CommandLine.Model.IGetter
that is responsible for getting the value of this argument, and returns this builder.public T setter(CommandLine.Model.ISetter setter)
CommandLine.Model.ISetter
that is responsible for modifying the value of this argument, and returns this builder.public T withToString(java.lang.String toString)