vertx / io.vertx.core.cli

Package io.vertx.core.cli

Types

Argument

open class Argument

Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The first index is 0 (because we are in the computer world).

CommandLine

interface CommandLine

The parser transforms a CLI (a model) into an CommandLine. This CommandLine has stored the argument and option values. Only instance of parser should create objects of this type.

TypedArgument

open class TypedArgument<T : Any> : Argument

An implementation of Argument for java specifying the type of object received by the argument. This allows converting the given raw value into the specified type.

TypedOption

open class TypedOption<T : Any> : Option

An implementation of Option for java specifying the type of object received by the option. This allows converting the given raw value into the specified type.

UsageMessageFormatter

open class UsageMessageFormatter

Usage message formatter.

Exceptions

AmbiguousOptionException

open class AmbiguousOptionException : CLIException

Exception thrown when the command line is ambiguous meaning it cannot determine exactly which option has to be set.

CLIException

open class CLIException : RuntimeException

High level exception thrown when an issue in the command line processing occurs.

InvalidValueException

open class InvalidValueException : CLIException

Exception thrown when an option or an argument receives an invalid value.

MissingOptionException

open class MissingOptionException : CLIException

Exception thrown when an option was expected and was not found on the command line.

MissingValueException

open class MissingValueException : CLIException

Exception thrown when an option requiring a value does not receive the value, or when a mandatory argument does not receive a value.