ChoiceGroup

class ChoiceGroup<GroupT : OptionGroup, OutT> : ParameterGroupDelegate<OutT>

Functions

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

Link copied to clipboard
open fun getValue(thisRef: CliktCommand, property: KProperty<*>): OutT
Link copied to clipboard
open fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Group?
Link copied to clipboard
open override 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
open operator override fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): <ERROR CLASS><CliktCommand, OutT>

Implementations must call CliktCommand.registerOptionGroup

Properties

Link copied to clipboard
open override val groupHelp: String? = null

A help message to display for this group.

Link copied to clipboard
open override val groupName: String? = null

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

Extensions

Link copied to clipboard
fun <T : OptionGroup> ChoiceGroup<T, T?>.defaultByName(name: String): ChoiceGroup<T, T>

If a groupChoice or groupSwitch option is not called on the command line, use the value of the group with a switch or choice name.

Link copied to clipboard
fun <T : OptionGroup> ChoiceGroup<T, T?>.required(): ChoiceGroup<T, T>

If a groupChoice or groupSwitch option is not called on the command line, throw a MissingOption exception.