vertx / io.vertx.reactivex.core.cli

Package io.vertx.reactivex.core.cli

Types

CLI

open class CLI

Interface defining a command-line interface (in other words a command such as 'run', 'ls'...). This interface is polyglot to ease reuse such as in Vert.x Shell. A command line interface has a name, and defines a set of options and arguments. Options are key-value pair such as -foo=bar or -flag. The supported formats depend on the used parser. Arguments are unlike options raw values. Options are defined using io.vertx.core.cli.Option, while argument are defined using io.vertx.core.cli.Argument. Command line interfaces also define a summary and a description. These attributes are used in the usage generation . To disable the help generation, set the hidden attribute to true. Command Line Interface object does not contains "value", it's a model. It must be evaluated by a parser that returns a io.vertx.reactivex.core.cli.CommandLine object containing the argument and option values. NOTE: This class has been automatically generated from the io.vertx.core.cli.CLI non RX-ified interface using Vert.x codegen.

CommandLine

open class CommandLine

The parser transforms a CLI (a model) into an io.vertx.reactivex.core.cli.CommandLine. This io.vertx.reactivex.core.cli.CommandLine has stored the argument and option values. Only instance of parser should create objects of this type. NOTE: This class has been automatically generated from the io.vertx.core.cli.CommandLine non RX-ified interface using Vert.x codegen.