Class CommandLine.Range
java.lang.Object
org.apache.logging.log4j.core.tools.picocli.CommandLine.Range
- All Implemented Interfaces:
Comparable<CommandLine.Range>
- Enclosing class:
- CommandLine
Describes the number of parameters required and accepted by an option or a positional parameter.
- Since:
- 0.9.7
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
final boolean
final int
Maximum accepted number of parameters for an option or positional parameter.final int
Required number of parameters for an option or positional parameter.private final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) static CommandLine.Range
adjustForType
(CommandLine.Range result, Field field) int
compareTo
(CommandLine.Range other) boolean
contains
(int value) Returnstrue
if this Range includes the specified value,false
otherwise.static CommandLine.Range
defaultArity
(Class<?> type) Returns the default arityRange
foroptions
: booleans have arity 0, other types have arity 1.static CommandLine.Range
defaultArity
(Field field) Returns the default arityRange
: foroptions
this is 0 for booleans and 1 for other types, forparameters
booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1.boolean
int
hashCode()
max
(int newMax) Returns a new Range object with themax
value replaced by the specified value.min
(int newMin) Returns a new Range object with themin
value replaced by the specified value.static CommandLine.Range
optionArity
(Field field) Returns a newRange
based on theCommandLine.Option.arity()
annotation on the specified field, or the field type's default arity if no arity was specified.static CommandLine.Range
parameterArity
(Field field) Returns a newRange
based on theCommandLine.Parameters.arity()
annotation on the specified field, or the field type's default arity if no arity was specified.(package private) static CommandLine.Range
parameterCapacity
(Field field) static CommandLine.Range
parameterIndex
(Field field) Returns a newRange
based on theCommandLine.Parameters.index()
annotation on the specified field.private static int
private int
size()
toString()
static CommandLine.Range
Leniently parses the specified String as anRange
value and return the result.
-
Field Details
-
min
public final int minRequired number of parameters for an option or positional parameter. -
max
public final int maxMaximum accepted number of parameters for an option or positional parameter. -
isVariable
public final boolean isVariable -
isUnspecified
private final boolean isUnspecified -
originalValue
-
-
Constructor Details
-
Range
Constructs a new Range object with the specified parameters.- Parameters:
min
- minimum number of required parametersmax
- maximum number of allowed parameters (or Integer.MAX_VALUE if variable)variable
-true
if any number or parameters is allowed,false
otherwiseunspecified
-true
if no arity was specified on the option/parameter (value is based on type)originalValue
- the original value that was specified on the option or parameter
-
-
Method Details
-
optionArity
Returns a newRange
based on theCommandLine.Option.arity()
annotation on the specified field, or the field type's default arity if no arity was specified.- Parameters:
field
- the field whose Option annotation to inspect- Returns:
- a new
Range
based on the Option arity annotation on the specified field
-
parameterArity
Returns a newRange
based on theCommandLine.Parameters.arity()
annotation on the specified field, or the field type's default arity if no arity was specified.- Parameters:
field
- the field whose Parameters annotation to inspect- Returns:
- a new
Range
based on the Parameters arity annotation on the specified field
-
parameterIndex
Returns a newRange
based on theCommandLine.Parameters.index()
annotation on the specified field.- Parameters:
field
- the field whose Parameters annotation to inspect- Returns:
- a new
Range
based on the Parameters index annotation on the specified field
-
adjustForType
-
defaultArity
Returns the default arityRange
: foroptions
this is 0 for booleans and 1 for other types, forparameters
booleans have arity 0, arrays or Collections have arity "0..*", and other types have arity 1.- Parameters:
field
- the field whose default arity to return- Returns:
- a new
Range
indicating the default arity of the specified field - Since:
- 2.0
-
defaultArity
Returns the default arityRange
foroptions
: booleans have arity 0, other types have arity 1.- Parameters:
type
- the type whose default arity to return- Returns:
- a new
Range
indicating the default arity of the specified type
-
size
private int size() -
parameterCapacity
-
valueOf
Leniently parses the specified String as anRange
value and return the result. A range string can be a fixed integer value or a range of the formMIN_VALUE + ".." + MAX_VALUE
. If theMIN_VALUE
string is not numeric, the minimum is zero. If theMAX_VALUE
is not numeric, the range is taken to be variable and the maximum isInteger.MAX_VALUE
.- Parameters:
range
- the value range string to parse- Returns:
- a new
Range
value
-
parseInt
-
min
Returns a new Range object with themin
value replaced by the specified value. Themax
of the returned Range is guaranteed not to be less than the newmin
value.- Parameters:
newMin
- themin
value of the returned Range object- Returns:
- a new Range object with the specified
min
value
-
max
Returns a new Range object with themax
value replaced by the specified value. Themin
of the returned Range is guaranteed not to be greater than the newmax
value.- Parameters:
newMax
- themax
value of the returned Range object- Returns:
- a new Range object with the specified
max
value
-
contains
public boolean contains(int value) Returnstrue
if this Range includes the specified value,false
otherwise.- Parameters:
value
- the value to check- Returns:
true
if the specified value is not less than the minimum and not greater than the maximum of this Range
-
equals
-
hashCode
public int hashCode() -
toString
-
compareTo
- Specified by:
compareTo
in interfaceComparable<CommandLine.Range>
-