argot-core/org.draftcode.argot/ArgotParseException

ArgotParseException

sealed class ArgotParseException : Exception

Base type for all user-input parsing failures. The cli wrapper prints usage and the message to stderr and exits 2.

Inheritors

MissingRequiredOption

MissingRequiredArgument

TooManyArguments

Types

class DuplicateValue(val name: String) : ArgotParseException

A single-valued option was supplied more than once.

class InvalidValue(val name: String, val raw: String, val expectedType: String) : ArgotParseException

A converter rejected a value.

MissingRequiredArgument

class MissingRequiredArgument(val name: String) : ArgotParseException

A required positional argument was not supplied.

MissingRequiredOption

class MissingRequiredOption(val name: String) : ArgotParseException

A required option was not supplied.

class MissingValue(val name: String) : ArgotParseException

An option that expects a value was supplied without one.

TooManyArguments

class TooManyArguments(val extra: List<String>) : ArgotParseException

More positional arguments were supplied than the command declares.

class UnknownOption(val name: String) : ArgotParseException

An unrecognized option or flag name was supplied.

Properties

open val cause: Throwable?

open val message: String?

var usage: String?

The command's one-line usage string, attached by the engine before the exception escapes.