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

OptionDelegate

interface OptionDelegate<T> : GroupableOption, ReadOnlyProperty<ParameterHolder, T> , PropertyDelegateProvider<ParameterHolder, ReadOnlyProperty<ParameterHolder, T>>

An option that functions as a property delegate

Inheritors

OptionWithValues

Properties

acceptsNumberValueWithoutName

open val acceptsNumberValueWithoutName: Boolean

If true, this option can be specified without a name e.g. -2 instead of -o2

acceptsUnattachedValue

open val acceptsUnattachedValue: Boolean

If false, invocations must be of the form --foo=1 or -f1. If true, the forms --foo 1 and -f 1 are also accepted.

completionCandidates

open val completionCandidates: CompletionCandidates

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

eager

open val eager: Boolean

If true, the presence of this option on the command line will halt parsing immediately

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: IntRange

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

parameterGroup

abstract var parameterGroup: ParameterGroup?

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

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

Functions

finalize

abstract fun finalize(context: Context, invocations: List<Invocation>)

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

getValue

open operator override 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.

optionHelp

abstract fun optionHelp(context: Context): String

The description of this option, usually a single line.

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 override fun provideDelegate(thisRef: ParameterHolder, property: KProperty<*>): ReadOnlyProperty<ParameterHolder, T>

Implementations must call ParameterHolder.registerOption