clikt-core/com.github.ajalt.clikt.parameters.arguments/ArgumentTransformContext

ArgumentTransformContext

class ArgumentTransformContext(val argument: Argument, val context: Context) : Argument, TransformContext

A receiver for argument transformers.

Constructors

constructor(argument: Argument, context: Context)

Properties

argument

val argument: Argument

The argument that was invoked

completionCandidates

open override val completionCandidates: CompletionCandidates

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

context

open override val context: Context

The current context object

helpTags

open override val helpTags: Map<String, String>

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

name

open override val name: String

The metavar for this argument.

nvalues

open override val nvalues: Int

The number of values that this argument takes.

required

open override val required: Boolean

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

Functions

fail

open override fun fail(message: String): Nothing

Throw an exception indicating that usage was incorrect.

finalize

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

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

getArgumentHelp

open override fun getArgumentHelp(context: Context): String

The description of this argument.

message

fun TransformContext.message(message: String)

Issue a message that can be shown to the user

parameterHelp

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

Information about this argument for the help output.

postValidate

open override fun postValidate(context: Context)

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

require

inline fun require(value: Boolean, lazyMessage: () -> String = { "" })

If value is false, call fail with the output of lazyMessage