| Package | Description | 
|---|---|
| io.vertx.core.cli | |
| io.vertx.reactivex.core.cli | |
| io.vertx.rxjava.core.cli | |
| io.vertx.rxjava3.core.cli | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | TypedArgument<T>An implementation of  Argumentfor java specifying the type of object received by the argument. | 
| Modifier and Type | Method and Description | 
|---|---|
| Argument | MissingValueException. getArgument() | 
| Argument | InvalidValueException. getArgument() | 
| Argument | CLI. getArgument(int index)Gets an  Argumentbased on its index. | 
| Argument | CLI. getArgument(String name)Gets an  Argumentbased on its name (argument name). | 
| Argument | Argument. setArgName(String argName)Sets the argument name of this  Argument. | 
| Argument | Argument. setDefaultValue(String defaultValue)Sets the default value of this  Argument. | 
| Argument | Argument. setDescription(String description)Sets the description of the  Argument. | 
| Argument | Argument. setHidden(boolean hidden)Sets whether or not the current  Argumentis hidden. | 
| Argument | Argument. setIndex(int index)Sets the argument index. | 
| Argument | Argument. setMultiValued(boolean multiValued)Sets whether or not the argument can receive several values. | 
| Argument | Argument. setRequired(boolean required)Sets whether or not the current  Argumentis required. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Argument> | CLI. getArguments()Gets the list of defined arguments. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArgument(Argument arg)Adds an argument. | 
| protected void | UsageMessageFormatter. appendArgument(StringBuilder buff,
              Argument argument,
              boolean required)Appends the usage clause for an Argument to a StringBuilder. | 
| String | CommandLine. getRawValueForArgument(Argument arg)Gets the raw value of the given argument. | 
| List<String> | CommandLine. getRawValuesForArgument(Argument argument)Gets the raw values of the given argument. | 
| boolean | CommandLine. isArgumentAssigned(Argument arg)Checks whether or not the given argument has been assigned in the command line. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArguments(List<Argument> args)Adds a set of arguments. | 
| void | UsageMessageFormatter. computeOptionsAndArguments(StringBuilder buffer,
                          List<Option> options,
                          List<Argument> arguments)Computes the help for the specified Options to the specified writer. | 
| protected StringBuilder | UsageMessageFormatter. renderOptionsAndArguments(StringBuilder sb,
                         List<Option> options,
                         List<Argument> arguments)Renders the specified Options and Arguments and return the rendered output
 in a StringBuilder. | 
| CLI | CLI. setArguments(List<Argument> args)Sets the list of arguments. | 
| Constructor and Description | 
|---|
| Argument(Argument other)Creates a new instance of  Argumentby copyingother. | 
| InvalidValueException(Argument argument,
                     String value,
                     Exception cause)Creates a new instance of  InvalidValueExceptionfor the given argument and the given value. | 
| MissingValueException(Argument argument)Creates a new instance of  MissingValueExceptionwhen a mandatory argument is not set in the user command
 line. | 
| Modifier and Type | Method and Description | 
|---|---|
| Argument | CLI. getArgument(int index)Gets an  Argumentbased on its index. | 
| Argument | CLI. getArgument(String name)Gets an  Argumentbased on its name (argument name). | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Argument> | CLI. getArguments()Gets the list of defined arguments. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArgument(Argument arg)Adds an argument. | 
| String | CommandLine. getRawValueForArgument(Argument arg)Gets the raw value of the given argument. | 
| List<String> | CommandLine. getRawValuesForArgument(Argument argument)Gets the raw values of the given argument. | 
| boolean | CommandLine. isArgumentAssigned(Argument arg)Checks whether or not the given argument has been assigned in the command line. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArguments(List<Argument> args)Adds a set of arguments. | 
| CLI | CLI. setArguments(List<Argument> args)Sets the list of arguments. | 
| Modifier and Type | Method and Description | 
|---|---|
| Argument | CLI. getArgument(int index)Gets an  Argumentbased on its index. | 
| Argument | CLI. getArgument(String name)Gets an  Argumentbased on its name (argument name). | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Argument> | CLI. getArguments()Gets the list of defined arguments. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArgument(Argument arg)Adds an argument. | 
| String | CommandLine. getRawValueForArgument(Argument arg)Gets the raw value of the given argument. | 
| List<String> | CommandLine. getRawValuesForArgument(Argument argument)Gets the raw values of the given argument. | 
| boolean | CommandLine. isArgumentAssigned(Argument arg)Checks whether or not the given argument has been assigned in the command line. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArguments(List<Argument> args)Adds a set of arguments. | 
| CLI | CLI. setArguments(List<Argument> args)Sets the list of arguments. | 
| Modifier and Type | Method and Description | 
|---|---|
| Argument | CLI. getArgument(int index)Gets an  Argumentbased on its index. | 
| Argument | CLI. getArgument(String name)Gets an  Argumentbased on its name (argument name). | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Argument> | CLI. getArguments()Gets the list of defined arguments. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArgument(Argument arg)Adds an argument. | 
| String | CommandLine. getRawValueForArgument(Argument arg)Gets the raw value of the given argument. | 
| List<String> | CommandLine. getRawValuesForArgument(Argument argument)Gets the raw values of the given argument. | 
| boolean | CommandLine. isArgumentAssigned(Argument arg)Checks whether or not the given argument has been assigned in the command line. | 
| Modifier and Type | Method and Description | 
|---|---|
| CLI | CLI. addArguments(List<Argument> args)Adds a set of arguments. | 
| CLI | CLI. setArguments(List<Argument> args)Sets the list of arguments. | 
Copyright © 2023 Eclipse. All rights reserved.