Option

data class Option(val names: Set<String>, val secondaryNames: Set<String>, val metavar: String?, val help: String, val nvalues: IntRange, val tags: Map<String, String>, val acceptsNumberValueWithoutName: Boolean, val acceptsUnattachedValue: Boolean, val groupName: String?) : HelpFormatter.ParameterHelp

Constructors

Link copied to clipboard
constructor(names: Set<String>, secondaryNames: Set<String>, metavar: String?, help: String, nvalues: IntRange, tags: Map<String, String>, acceptsNumberValueWithoutName: Boolean, acceptsUnattachedValue: Boolean, groupName: String?)

Properties

Link copied to clipboard

True if this option can be called like -1, -2 etc.

Link copied to clipboard

True if this option can be called like --option 1 in addition to --option=1

Link copied to clipboard

The name of the group this option belongs to, if there is one and its name should be shown in the help message

Link copied to clipboard

The option's description

Link copied to clipboard

The metavar to display for the option if it takes values

Link copied to clipboard

The names that can be used to invoke this option

Link copied to clipboard

The number of values that this option takes

Link copied to clipboard

Secondary names that can be used to e.g. disable the option

Link copied to clipboard

Any extra tags to display with the help message for this option