This class provides useful shortcuts and constants.
They are mainly used to specify parameter to Argument
object.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final AppendArgumentAction
private static final AppendConstArgumentAction
private static final CountArgumentAction
private static final HelpArgumentAction
private static final StoreArgumentAction
private static final StoreConstArgumentAction
private static final StoreFalseArgumentAction
private static final StoreTrueArgumentAction
static final FeatureControl
The value ofFeatureControl.SUPPRESS
.private static final VersionArgumentAction
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Intentionally made private to avoid instantiation in application code. -
Method Summary
Modifier and TypeMethodDescriptionstatic AppendArgumentAction
append()
Returns append action.static AppendConstArgumentAction
Returns appendConst action.static BooleanArgumentType
ReturnsBooleanArgumentType
with "true" as true value, and "false" as false value.static BooleanArgumentType
booleanType
(String trueValue, String falseValue) ReturnsBooleanArgumentType
with given true/false values.static <T extends Enum<T>>
CaseInsensitiveEnumStringArgumentType<T> caseInsensitiveEnumStringType
(Class<T> type) ReturnsCaseInsensitiveEnumStringArgumentType
with given enumtype
.static <T extends Enum<T>>
CaseInsensitiveEnumNameArgumentType<T> caseInsensitiveEnumType
(Class<T> type) ReturnsCaseInsensitiveEnumNameArgumentType
with given enumtype
.static CountArgumentAction
count()
Returns count action.static <T extends Enum<T>>
EnumStringArgumentType<T> enumStringType
(Class<T> type) ReturnsEnumStringArgumentType
with given enumtype
.static <T extends Enum<T>>
EnumArgumentType<T> Deprecated.static FileArgumentType
fileType()
Returns newFileArgumentType
object.static HelpArgumentAction
help()
Returns help action.static <T extends Comparable<T>>
RangeArgumentChoice<T> range
(T min, T max) Creates new range constrained choice.static StoreArgumentAction
store()
Returns store action.static StoreConstArgumentAction
Returns storeConst action.static StoreFalseArgumentAction
Returns storeFalse action.static StoreTrueArgumentAction
Returns storeTrue action.static VersionArgumentAction
version()
Returns version action.
-
Field Details
-
store_
-
storeTrue_
-
storeFalse_
-
storeConst_
-
append_
-
appendConst_
-
help_
-
version_
-
count_
-
SUPPRESS
The value of
FeatureControl.SUPPRESS
.If value is used with
Argument.setDefault(FeatureControl)
, no attribute is added if the command line argument was not present. Otherwise, the default value, which defaults to null, will be added to the object, regardless of the presence of command line argument, returned byArgumentParser.parseArgs(String[])
.
-
-
Constructor Details
-
Arguments
private Arguments()Intentionally made private to avoid instantiation in application code.
-
-
Method Details
-
range
Creates new range constrained choice.
The value specified in command line will be checked to see whether it fits in given range [min, max], inclusive.
- Type Parameters:
T
- The type of the values in the range- Parameters:
min
- The lower bound of the range, inclusive.max
- The upper bound of the range, inclusive.- Returns:
RangeArgumentChoice
object.
-
store
Returns store action.- Returns:
StoreArgumentAction
object.
-
storeTrue
Returns storeTrue action.
If this action is used, the value specified using
Argument.nargs(int)
will be ignored.- Returns:
StoreTrueArgumentAction
object.
-
storeFalse
Returns storeFalse action.
If this action is used, the value specified using
Argument.nargs(int)
will be ignored.- Returns:
StoreFalseArgumentAction
object.
-
storeConst
Returns storeConst action.
If this action is used, the value specified using
Argument.nargs(int)
will be ignored.- Returns:
StoreConstArgumentAction
object.
-
append
Returns append action.
If this action is used, the attribute will be of type
List
. If used withArgument.nargs(int)
, the element of List will be List. This is becauseArgument.nargs(int)
produces List.- Returns:
AppendArgumentAction
object.
-
appendConst
Returns appendConst action.
If this action is used, the value specified using
Argument.nargs(int)
will be ignored.- Returns:
AppendConstArgumentAction
object.
-
help
Returns help action.
This is used for an option printing help message. Please note that this action terminates program after printing help message.
- Returns:
HelpArgumentAction
object.
-
version
Returns version action.
This is used for an option printing version message. Please note that this action terminates program after printing version message.
- Returns:
VersionArgumentAction
object.
-
count
Returns count action.
This action counts the number of occurrence of the option. This action does not consume argument.
- Returns:
CountArgumentAction
object.
-
enumType
Deprecated.Returns
EnumArgumentType
with given enumtype
.Since enum does not have a constructor with string argument, you cannot use
Argument.type(Class)
. Instead use this convenient function.- Type Parameters:
T
- The type of the enum- Parameters:
type
- The enum type- Returns:
EnumArgumentType
object
-
fileType
Returns new
FileArgumentType
object.- Returns:
FileArgumentType
object
-
enumStringType
Returns
EnumStringArgumentType
with given enumtype
.Uses
Enum.toString()
instead ofEnum.name()
as the String representation of the enum. For enums that do not overrideEnum.toString()
, this behaves the same asReflectArgumentType
or just useArgument.type(Class)
.- Type Parameters:
T
- The type of the enum- Parameters:
type
- The enum type- Returns:
EnumStringArgumentType
object
-
caseInsensitiveEnumType
public static <T extends Enum<T>> CaseInsensitiveEnumNameArgumentType<T> caseInsensitiveEnumType(Class<T> type) Returns
CaseInsensitiveEnumNameArgumentType
with given enumtype
.Uses
Enum.name()
as the String representation of the enum.- Type Parameters:
T
- The type of the enum- Parameters:
type
- The enum type- Returns:
CaseInsensitiveEnumNameArgumentType
object- Since:
- 0.8.0
-
caseInsensitiveEnumStringType
public static <T extends Enum<T>> CaseInsensitiveEnumStringArgumentType<T> caseInsensitiveEnumStringType(Class<T> type) Returns
CaseInsensitiveEnumStringArgumentType
with given enumtype
.Uses
Enum.toString()
instead ofEnum.name()
as the String representation of the enum. For enums that do not overrideEnum.toString()
, this behaves the same asCaseInsensitiveEnumNameArgumentType
.- Type Parameters:
T
- The type of the enum- Parameters:
type
- The enum type- Returns:
CaseInsensitiveEnumStringArgumentType
object- Since:
- 0.8.0
-
booleanType
Returns
BooleanArgumentType
with "true" as true value, and "false" as false value.Read
BooleanArgumentType
documentation to know the difference between the use ofBooleanArgumentType
and passingBoolean
class toArgument.type(Class)
.- Returns:
- The BooleanArgumentType object
- Since:
- 0.7.0
-
booleanType
Returns
BooleanArgumentType
with given true/false values.Read
BooleanArgumentType
documentation to know the difference between the use ofBooleanArgumentType
and passingBoolean
class toArgument.type(Class)
.- Parameters:
trueValue
- string used as true valuefalseValue
- string used as false value- Returns:
- The BooleanArgumentType object
- Since:
- 0.7.0
-