ArgumentDelegate

interface ArgumentDelegate<out T> : Argument

An argument that functions as a property delegate

Functions

Link copied to clipboard
abstract fun finalize(context: Context, values: List<String>)

Called after this command's argv is parsed to transform and store the argument's value.

Link copied to clipboard
abstract fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Argument?

Information about this argument for the help output.

Link copied to clipboard
abstract fun postValidate(context: Context)

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

Link copied to clipboard
abstract operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): <ERROR CLASS><CliktCommand, T>

Implementations must call CliktCommand.registerArgument

Properties

Link copied to clipboard
abstract val argumentHelp: String

The description of this argument.

Link copied to clipboard
open val completionCandidates: CompletionCandidates

Optional set of strings to use when the user invokes shell autocomplete on a value for this argument.

Link copied to clipboard
abstract val helpTags: Map<String, String>

Extra information about this argument to pass to the help formatter.

Link copied to clipboard
abstract val name: String

The metavar for this argument.

Link copied to clipboard
abstract val nvalues: Int

The number of values that this argument takes.

Link copied to clipboard
abstract val required: Boolean

If true, an error will be thrown if this argument is not given on the command line.

Inheritors

Link copied to clipboard