Package io.airlift.airline
Annotation Type Option
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionString[]intHow many parameter values this option will consume.A description of this option.booleanIf true, this parameter won't appear in the usage().booleanWhether this option is required.Name used to identify the option value in documentation and error messages.Is this a command, group or global option
-
Element Details
-
type
OptionType typeIs this a command, group or global option- Default:
COMMAND
-
title
String titleName used to identify the option value in documentation and error messages.- Default:
""
-
name
String[] nameAn array of allowed command line parameters (e.g. "-n", "--name", etc...). -
description
String descriptionA description of this option.- Default:
""
-
required
boolean requiredWhether this option is required.- Default:
false
-
arity
int arityHow many parameter values this option will consume. For example, an arity of 2 will allow "-pair value1 value2".- Default:
-2147483648
-
allowedValues
String[] allowedValues- Default:
{}
-