UsageError

An internal exception that signals a usage error.

The option and argument properties are used in message formatting, and can be set after the exception is created. If this is thrown inside a call to convert, the argument or option value will be set automatically

Constructors

UsageError

common

fun UsageError(text: String, paramName: String? = null, context: Context? = null, statusCode: Int = 1)

UsageError

common

fun UsageError(text: String, argument: Argument, context: Context? = null, statusCode: Int = 1)

UsageError

common

fun UsageError(text: String, option: Option, context: Context? = null, statusCode: Int = 1)

Functions

helpMessage

common

fun helpMessage(): String

Properties

argument

common

var argument: Argument? = null

The argument that caused this error.

cause

common

open val cause: Throwable?

context

common

var context: Context? = null

message

common

open override val message: String?

option

common

var option: Option? = null

The option that caused this error.

paramName

common

var paramName: String? = null

The name of the parameter that caused the error.

statusCode

common

val statusCode: Int = 1

The value to use as the exit code for the process.

text

common

val text: String? = null

Extra text to add to the message.

Inheritors

BadParameterValue

MissingOption

MissingArgument

NoSuchParameter

IncorrectOptionValueCount

IncorrectArgumentValueCount

MutuallyExclusiveGroupException

FileNotFound

InvalidFileFormat