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

ChoiceGroup

class ChoiceGroup<GroupT : OptionGroup, OutT> : ParameterGroupDelegate<OutT>
Content copied to clipboard

Functions

Link copied to clipboard
open override fun finalize(context: Context, invocationsByOption: Map<Option, List<OptionParser.Invocation>>)
Content copied to clipboard

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

Link copied to clipboard
open operator override fun getValue(thisRef: CliktCommand, property: KProperty<*>): OutT
Content copied to clipboard
Link copied to clipboard
open fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Group?
Content copied to clipboard
Link copied to clipboard
open override fun postValidate(context: Context)
Content copied to clipboard

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<*>): ReadOnlyProperty<CliktCommand, OutT>
Content copied to clipboard

Implementations must call CliktCommand.registerOptionGroup

Properties

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

A help message to display for this group.

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

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>
Content copied to clipboard

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>
Content copied to clipboard

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