Uses of Class
io.vertx.core.cli.Option

Packages that use Option

Package	Description
io.vertx.core.cli
io.vertx.reactivex.core.cli
io.vertx.rxjava.core.cli
io.vertx.rxjava3.core.cli

Uses of Option in io.vertx.core.cli

Subclasses of Option in io.vertx.core.cli

Modifier and Type	Class and Description
class	TypedOption<T> An implementation of Option for java specifying the type of object received by the option.

Fields in io.vertx.core.cli with type parameters of type Option

Modifier and Type	Field and Description
protected Comparator<Option>	UsageMessageFormatter.optionComparator Comparator used to sort the options when they output in help text Defaults to case-insensitive alphabetical sorting by option key.

Methods in io.vertx.core.cli that return Option

Modifier and Type	Method and Description
Option	Option.addChoice(String choice) Adds a choice to the list of values accepted by this option.
Option	MissingValueException.getOption()
Option	InvalidValueException.getOption()
Option	CLI.getOption(String name) Gets an Option based on its name (short name, long name or argument name).
Option	Option.setArgName(String argName) Sets te arg name for this option.
Option	Option.setChoices(Set<String> choices) Sets the list of values accepted by this option.
Option	Option.setDefaultValue(String defaultValue) Sets the default value of this option
Option	Option.setDescription(String description) Sets te description of this option.
Option	Option.setFlag(boolean flag) Configures the current Option to be a flag.
Option	Option.setHelp(boolean help) Sets whether or not this option is a "help" option
Option	Option.setHidden(boolean hidden) Sets whether or not this option should be hidden
Option	Option.setLongName(String longName) Sets the long name of this option.
Option	Option.setMultiValued(boolean multiValued) Sets whether or not this option can receive several values.
Option	Option.setRequired(boolean required) Sets whether or not this option is mandatory.
Option	Option.setShortName(String shortName) Sets the short name of this option.
Option	Option.setSingleValued(boolean singleValued) Sets whether or not this option can receive a value.

Methods in io.vertx.core.cli that return types with arguments of type Option

Modifier and Type	Method and Description
Collection<Option>	MissingOptionException.getExpected()
Comparator<Option>	UsageMessageFormatter.getOptionComparator() Comparator used to sort the options when they output in help text.
List<Option>	CLI.getOptions() Gets the list of options.
List<Option>	AmbiguousOptionException.getOptions()

Methods in io.vertx.core.cli with parameters of type Option

Modifier and Type	Method and Description
boolean	CommandLine.acceptMoreValues(Option option) Checks whether or not the given option accept more values.
CLI	CLI.addOption(Option option) Adds an option.
protected void	UsageMessageFormatter.appendOption(StringBuilder buff, Option option) Appends the usage clause for an Option to a StringBuilder.
String	CommandLine.getRawValueForOption(Option option) Gets the raw value of the given option.
default List<String>	CommandLine.getRawValues(Option option) Deprecated. use CommandLine.getRawValuesForOption(Option)
List<String>	CommandLine.getRawValuesForOption(Option option) Gets the raw values of the given option.
boolean	CommandLine.isOptionAssigned(Option option) Checks whether or not the given option has been assigned in the command line.
boolean	CommandLine.isSeenInCommandLine(Option option) Checks whether or not the given option has been seen in the user command line.

Method parameters in io.vertx.core.cli with type arguments of type Option

Modifier and Type	Method and Description
CLI	CLI.addOptions(List<Option> options) Adds a set of options.
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.
void	UsageMessageFormatter.setOptionComparator(Comparator<Option> comparator) Set the comparator used to sort the options when they output in help text.
CLI	CLI.setOptions(List<Option> options) Sets the list of arguments.

Constructors in io.vertx.core.cli with parameters of type Option

Constructor and Description
InvalidValueException(Option option, String value) Creates a new instance of InvalidValueException for the given option and the given value.
InvalidValueException(Option option, String value, Exception cause) Creates a new instance of InvalidValueException for the given option and the given value.
MissingValueException(Option option) Creates a new instance of MissingValueException when an option requiring a value does not receive a value.
Option(Option other) Creates a new instance of Option by copying the state of another Option.

Constructor parameters in io.vertx.core.cli with type arguments of type Option

Constructor and Description
AmbiguousOptionException(String token, List<Option> matchingOpts) Creates a new instance of AmbiguousOptionException.
MissingOptionException(Collection<Option> expected) Creates a new instance of MissingOptionException.

Uses of Option in io.vertx.reactivex.core.cli

Methods in io.vertx.reactivex.core.cli that return Option

Modifier and Type	Method and Description
Option	CLI.getOption(String name) Gets an Option based on its name (short name, long name or argument name).

Methods in io.vertx.reactivex.core.cli that return types with arguments of type Option

Modifier and Type	Method and Description
List<Option>	CLI.getOptions() Gets the list of options.

Methods in io.vertx.reactivex.core.cli with parameters of type Option

Modifier and Type	Method and Description
boolean	CommandLine.acceptMoreValues(Option option) Checks whether or not the given option accept more values.
CLI	CLI.addOption(Option option) Adds an option.
String	CommandLine.getRawValueForOption(Option option) Gets the raw value of the given option.
List<String>	CommandLine.getRawValues(Option option) Deprecated.
List<String>	CommandLine.getRawValuesForOption(Option option) Gets the raw values of the given option.
boolean	CommandLine.isOptionAssigned(Option option) Checks whether or not the given option has been assigned in the command line.
boolean	CommandLine.isSeenInCommandLine(Option option) Checks whether or not the given option has been seen in the user command line.

Method parameters in io.vertx.reactivex.core.cli with type arguments of type Option

Modifier and Type	Method and Description
CLI	CLI.addOptions(List<Option> options) Adds a set of options.
CLI	CLI.setOptions(List<Option> options) Sets the list of arguments.

Uses of Option in io.vertx.rxjava.core.cli

Methods in io.vertx.rxjava.core.cli that return Option

Modifier and Type	Method and Description
Option	CLI.getOption(String name) Gets an Option based on its name (short name, long name or argument name).

Methods in io.vertx.rxjava.core.cli that return types with arguments of type Option

Modifier and Type	Method and Description
List<Option>	CLI.getOptions() Gets the list of options.

Methods in io.vertx.rxjava.core.cli with parameters of type Option

Modifier and Type	Method and Description
boolean	CommandLine.acceptMoreValues(Option option) Checks whether or not the given option accept more values.
CLI	CLI.addOption(Option option) Adds an option.
String	CommandLine.getRawValueForOption(Option option) Gets the raw value of the given option.
List<String>	CommandLine.getRawValues(Option option) Deprecated.
List<String>	CommandLine.getRawValuesForOption(Option option) Gets the raw values of the given option.
boolean	CommandLine.isOptionAssigned(Option option) Checks whether or not the given option has been assigned in the command line.
boolean	CommandLine.isSeenInCommandLine(Option option) Checks whether or not the given option has been seen in the user command line.

Method parameters in io.vertx.rxjava.core.cli with type arguments of type Option

Modifier and Type	Method and Description
CLI	CLI.addOptions(List<Option> options) Adds a set of options.
CLI	CLI.setOptions(List<Option> options) Sets the list of arguments.

Uses of Option in io.vertx.rxjava3.core.cli

Methods in io.vertx.rxjava3.core.cli that return Option

Modifier and Type	Method and Description
Option	CLI.getOption(String name) Gets an Option based on its name (short name, long name or argument name).

Methods in io.vertx.rxjava3.core.cli that return types with arguments of type Option

Modifier and Type	Method and Description
List<Option>	CLI.getOptions() Gets the list of options.

Methods in io.vertx.rxjava3.core.cli with parameters of type Option

Modifier and Type	Method and Description
boolean	CommandLine.acceptMoreValues(Option option) Checks whether or not the given option accept more values.
CLI	CLI.addOption(Option option) Adds an option.
String	CommandLine.getRawValueForOption(Option option) Gets the raw value of the given option.
List<String>	CommandLine.getRawValues(Option option) Deprecated.
List<String>	CommandLine.getRawValuesForOption(Option option) Gets the raw values of the given option.
boolean	CommandLine.isOptionAssigned(Option option) Checks whether or not the given option has been assigned in the command line.
boolean	CommandLine.isSeenInCommandLine(Option option) Checks whether or not the given option has been seen in the user command line.

Method parameters in io.vertx.rxjava3.core.cli with type arguments of type Option

Modifier and Type	Method and Description
CLI	CLI.addOptions(List<Option> options) Adds a set of options.
CLI	CLI.setOptions(List<Option> options) Sets the list of arguments.