clikt/com.github.ajalt.clikt.core/MissingArgument

MissingArgument

class MissingArgument(var argument: Argument, var context: Context? = null) : UsageError

A required argument was not provided

Constructors

MissingArgument

fun MissingArgument(argument: Argument, context: Context? = null)

Functions

fun helpMessage(): String

Properties

var argument: Argument? = null

The argument that caused this error. This may be set after the error is thrown.

open val cause: Throwable?

var context: Context? = null

open override val message: String?

var option: Option? = null

The option that caused this error. This may be set after the error is thrown.

var paramName: String? = null

The name of the parameter that caused the error. If possible, this should be set to the actual name used. If not set, it will be inferred from argument or option if either is set.

val statusCode: Int = 1

The value to use as the exit code for the process. If you use CliktCommand.main, it will pass this value to exitProcess after printing message. Defaults to 1.

val text: String? = null

Extra text to add to the message. Not all subclasses uses this.