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

ParameterGroupDelegate

interface ParameterGroupDelegate<out T> : ParameterGroup, ReadOnlyProperty<BaseCliktCommand<*>, T> , PropertyDelegateProvider<BaseCliktCommand<*>, ReadOnlyProperty<BaseCliktCommand<*>, T>>

A ParameterGroup that can be used as a property delegate

Inheritors

Properties

Link copied to clipboard
abstract val groupHelp: String?

A help message to display for this group.

Link copied to clipboard
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.

Functions

Link copied to clipboard
abstract fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionInvocation>>)

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

Link copied to clipboard
abstract operator fun getValue(thisRef: BaseCliktCommand<*>, property: KProperty<*>): T
Link copied to clipboard
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 values.

Link copied to clipboard
abstract operator override fun provideDelegate(thisRef: BaseCliktCommand<*>, property: KProperty<*>): ReadOnlyProperty<BaseCliktCommand<*>, T>

Implementations must call BaseCliktCommand<*>.registerOptionGroup