clikt/com.github.ajalt.clikt.parameters.options/OptionDelegate

OptionDelegate

interface OptionDelegate<T> : GroupableOption

An option that functions as a property delegate

Functions

finalize

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.

getValue

open fun getValue(thisRef: ParameterHolder, property: KProperty<*>): T

metavar

abstract fun metavar(context: Context): String?

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

parameterHelp

open fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Option?

Information about this option for the help output.

postValidate

abstract fun postValidate(context: Context)

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

provideDelegate

abstract operator fun provideDelegate(thisRef: ParameterHolder, prop: KProperty<*>): <ERROR CLASS><ParameterHolder, T>

Implementations must call ParameterHolder.registerOption

Properties

completionCandidates

open val completionCandidates: CompletionCandidates

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

groupName

abstract override var groupName: String?

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

helpTags

abstract val helpTags: Map<String, String>

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

hidden

abstract val hidden: Boolean

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

names

abstract val names: Set<String>

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

nvalues

abstract val nvalues: Int

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

optionHelp

abstract val optionHelp: String

The description of this option, usually a single line.

parameterGroup

abstract var parameterGroup: ParameterGroup?

The group that this option belongs to, or null. Set by the group.

parser

abstract val parser: OptionParser

The parser for this option's values.

secondaryNames

abstract val secondaryNames: Set<String>

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

value

abstract val value: T

The value for this option.

valueSourceKey

abstract val valueSourceKey: String?

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

Inheritors

FlagOption

OptionWithValues