vertx / io.vertx.core.cli.annotations

## Package io.vertx.core.cli.annotations

### Types

CLIConfigurator | `open class CLIConfigurator` Class responsible for defining CLI using annotations and injecting values extracted by the parser.

### Annotations

Argument | `class Argument` Annotates a setter to be called with the value of a command line argument.
ConvertedBy | `class ConvertedBy` Annotates Option setters to indicate how the value is converted to the argument type.
DefaultValue | `class DefaultValue` Annotation to set a default value to an option.
Description | `class Description` Annotation used to write the option or command documentation.
Hidden | `class Hidden` Annotates a io.vertx.core.cli.CLI and/or its Option setters to hide it from the help message.
Name | `class Name` Defines the name of a CLI.
Option | `class Option` Annotates a setter to be called with the value of a command line option. Setter have been preferred to field to allow validation. The cardinality of the option is detected from the single method parameter type: arrays, list and set can receive several values.
ParsedAsList | `class ParsedAsList` Annotates a setter to be called with the value of a command line option. The setter must also have been annotated with Option. When annotated with ParsedAsList, the option value is parsed as a list. The value is split and then each segment is trimmed.
Summary | `class Summary` Annotates a io.vertx.core.cli.CLI with summary. The summary is the main short explanation of the command. Long description should be written in the Description.