StaticallyGroupedOption

Functions

Link copied to clipboard
abstract fun finalize(context: Context, invocations: List<OptionParser.Invocation>)

Called after this command's argv is parsed to transform and store the option's value.

Link copied to clipboard
abstract fun metavar(context: Context): String?

A name representing the values for this option that can be displayed to the user.

Link copied to clipboard

Information about this option for the help output.

Link copied to clipboard
abstract fun postValidate(context: Context)

Called after all of a command's parameters have been finalized to perform validation of the final value.

Properties

Link copied to clipboard

Optional set of strings to use when the user invokes shell autocomplete on a value for this option.

Link copied to clipboard
abstract val groupName: String?

The name of the group, or null if this option should not be grouped in the help output.

Link copied to clipboard
abstract val helpTags: Map<String, String>

Extra information about this option to pass to the help formatter.

Link copied to clipboard
abstract val hidden: Boolean

If true, this option should not appear in help output.

Link copied to clipboard
abstract val names: Set<String>

The names that can be used to invoke this option. They must start with a punctuation character.

Link copied to clipboard
abstract val nvalues: Int

The number of values that must be given to this option.

Link copied to clipboard
abstract val optionHelp: String

The description of this option, usually a single line.

Link copied to clipboard
abstract val parser: OptionParser

The parser for this option's values.

Link copied to clipboard
abstract val secondaryNames: Set<String>

Names that can be used for a secondary purpose, like disabling flag options.

Link copied to clipboard
abstract val valueSourceKey: String?

Optional explicit key to use when looking this option up from a ValueSource

Inheritors

Link copied to clipboard
Link copied to clipboard