Argument

interface Argument

A positional parameter to a command.

Arguments can take any number of values.

Functions

finalize

common

abstract fun finalize(context: Context, values: List<String>)

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

parameterHelp

common

Information about this argument for the help output.

postValidate

common

abstract fun postValidate(context: Context)

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

argumentHelp

common

The description of this argument.

completionCandidates

common

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

helpTags

common

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

name

common

abstract val name: String

The metavar for this argument.

nvalues

common

abstract val nvalues: Int

The number of values that this argument takes.

required

common

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

ArgumentDelegate

ArgumentTransformContext