Models command line options. Options are values passed to a command line interface using -x or –x. Supported syntaxes depend on the parser.
Short name is generally used with a single dash, while long name requires a double-dash.AnythingObjectOptionBaseDataObjectBasicIdentifiableObjectAnythingno subtypes hierarchy
| Initializer |
Option(String? argName = null, {String*}? choices = null, String? defaultValue = null, String? description = null, Boolean? flag = null, Boolean? help = null, Boolean? hidden = null, String? longName = null, Boolean? multiValued = null, String? name = null, Boolean? required = null, String? shortName = null, Boolean? singleValued = null)Parameters:
|
| Attributes | |
argName | shared String? argNameSets te arg name for this option. |
choices | shared {String*}? choicesSets the list of values accepted by this option. If the value set by the user does not match once of these
values, a |
defaultValue | shared String? defaultValueSets the default value of this option |
description | shared String? descriptionSets te description of this option. |
flag | shared Boolean? flagConfigures the current Option to be a flag. It will be evaluated to |
help | shared Boolean? helpSets whether or not this option is a “help” option |
shared Boolean? hiddenSets whether or not this option should be hidden | |
longName | shared String? longNameSets the long name of this option. |
multiValued | shared Boolean? multiValuedSets whether or not this option can receive several values. |
name | shared String? name@return the option name. It returns the long name if set, the short name otherwise. It cannot return |
required | shared Boolean? requiredSets whether or not this option is mandatory. |
shortName | shared String? shortNameSets the short name of this option. |
singleValued | shared Boolean? singleValuedSets whether or not this option can receive a value. |
| Inherited Attributes |
Attributes inherited from: Objecthash, string |