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

Package-level declarations

Types

ChoiceGroup

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

CoOccurringOptionGroup

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

CoOccurringOptionGroupTransform

typealias CoOccurringOptionGroupTransform<GroupT, OutT> = (occurred: Boolean?, group: GroupT, context: Context) -> OutT

MutuallyExclusiveOptions

class MutuallyExclusiveOptions<OptT : Any, OutT> : ParameterGroupDelegate<OutT>

MutuallyExclusiveOptionsTransform

typealias MutuallyExclusiveOptionsTransform<OptT, OutT> = MutuallyExclusiveOptionTransformContext.(List<OptT>) -> OutT

MutuallyExclusiveOptionTransformContext

class MutuallyExclusiveOptionTransformContext(val context: Context)

OptionGroup

open class OptionGroup(name: String? = null, help: String? = null) : ParameterGroup, ParameterHolder

A group of options that can be shown together in help output, or restricted to be cooccurring.

ParameterGroup

interface ParameterGroup

ParameterGroupDelegate

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

A ParameterGroup that can be used as a property delegate

Functions

cooccurring

fun <T : OptionGroup> T.cooccurring(): CoOccurringOptionGroup<T, T?>

Make this group a co-occurring group.

default

fun <T : Any> MutuallyExclusiveOptions<T, T?>.default(value: T): MutuallyExclusiveOptions<T, T>

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

defaultByName

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.

groupChoice

fun <T : OptionGroup> RawOption.groupChoice(vararg choices: Pair<String, T>): ChoiceGroup<T, T?>

fun <T : OptionGroup> RawOption.groupChoice(choices: Map<String, T>): ChoiceGroup<T, T?>

Convert the option to an option group based on a fixed set of values.

groupSwitch

fun <T : OptionGroup> RawOption.groupSwitch(vararg choices: Pair<String, T>): ChoiceGroup<T, T?>

fun <T : OptionGroup> RawOption.groupSwitch(choices: Map<String, T>): ChoiceGroup<T, T?>

Convert the option into a set of flags that each map to an option group.

help

fun <OptT : Any, OutT> MutuallyExclusiveOptions<OptT, OutT>.help(name: String, help: String): MutuallyExclusiveOptions<OptT, OutT>

Set the name and help for this option.

mutuallyExclusiveOptions

fun <T : Any> ParameterHolder.mutuallyExclusiveOptions(option1: OptionDelegate<out T?>, option2: OptionDelegate<out T?>, vararg options: OptionDelegate<out T?>, name: String? = null, help: String? = null): MutuallyExclusiveOptions<T, T?>

Declare a set of two or more mutually exclusive options.

provideDelegate

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

required

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.

fun <T : Any> MutuallyExclusiveOptions<T, T?>.required(): MutuallyExclusiveOptions<T, T>

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

single

fun <T : Any> MutuallyExclusiveOptions<T, T?>.single(): MutuallyExclusiveOptions<T, T?>

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