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

ParameterGroup

interface ParameterGroup

Inheritors

ParameterGroupDelegate

Properties

abstract val groupHelp: String?

A help message to display for this group.

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

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.

open fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Group?

abstract fun postValidate(context: Context)

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