MutuallyExclusiveOptions

Properties

A help message to display for this group.

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

If none of the options in a mutuallyExclusiveOptions group are given on the command line, us value for the group.

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

open operator override fun getValue(thisRef: BaseCliktCommand<*>, property: KProperty<*>): OutT

Set the name and help for this option.

open override fun postValidate(context: Context)

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

Implementations must call BaseCliktCommand<*>.registerOptionGroup

Make a mutuallyExclusiveOptions group required. If none of the options in the group are given, a UsageError is thrown.

If more than one of the group's options are given on the command line, throw a MutuallyExclusiveGroupException