clikt/com.github.ajalt.clikt.parameters.groups/ParameterGroupDelegate

ParameterGroupDelegate

interface ParameterGroupDelegate<out T> : ParameterGroup, ReadOnlyProperty<CliktCommand, T>

Functions

abstract fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionParser.Invocation>>)

Called after this command's argv is parsed and all options are validated to validate the group constraints.

abstract operator fun getValue(thisRef: CliktCommand, property: KProperty<*>): T

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

abstract fun postValidate(context: Context)

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

provideDelegate

abstract operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>

Implementations must call CliktCommand.registerOptionGroup

Properties

abstract val groupHelp: String?

A help message to display for this group.

abstract val groupName: String?

The name of the group, or null if parameters in the group should not be separated from other parameters in the help output.

Inheritors

CoOccurringOptionGroup

MutuallyExclusiveOptions