Index (Vert.x 4 CLI Framework (Legacy) 5.0.4 API)

A B C D E F G H I L M N O P R S T U V
All Classes All Packages

A

acceptMoreValues(Option) - Method in interface io.vertx.core.cli.CommandLine: Checks whether or not the given option accept more values.
acceptMultipleValues() - Method in annotation type io.vertx.core.cli.annotations.Option: Whether or not the option accept multiple values.
acceptValue() - Method in annotation type io.vertx.core.cli.annotations.Option: Whether or not the option accept a value.
acceptValue() - Method in class io.vertx.core.cli.Option
addArgument(Argument) - Method in interface io.vertx.core.cli.CLI: Adds an argument.
addArguments(List<Argument>) - Method in interface io.vertx.core.cli.CLI: Adds a set of arguments.
addChoice(String) - Method in class io.vertx.core.cli.Option: Adds a choice to the list of values accepted by this option.
addChoice(String) - Method in class io.vertx.core.cli.TypedOption
addOption(Option) - Method in interface io.vertx.core.cli.CLI: Adds an option.
addOptions(List<Option>) - Method in interface io.vertx.core.cli.CLI: Adds a set of options.
afterConfigParsed(JsonObject) - Method in class io.vertx.core.Launcher: Hook for sub-classes of Launcher after the config has been parsed.
afterStartingVertx(Vertx) - Method in class io.vertx.core.Launcher: Hook for sub-classes of Launcher after the vertx instance is started.
afterStoppingVertx() - Method in class io.vertx.core.Launcher
allArguments() - Method in interface io.vertx.core.cli.CommandLine
AmbiguousOptionException - Exception in io.vertx.core.cli: Exception thrown when the command line is ambiguous meaning it cannot determine exactly which option has to be set.
AmbiguousOptionException(String, List<Option>) - Constructor for exception io.vertx.core.cli.AmbiguousOptionException: Creates a new instance of AmbiguousOptionException.
appendArgument(StringBuilder, Argument, boolean) - Method in class io.vertx.core.cli.UsageMessageFormatter: Appends the usage clause for an Argument to a StringBuilder.
appendOption(StringBuilder, Option) - Method in class io.vertx.core.cli.UsageMessageFormatter: Appends the usage clause for an Option to a StringBuilder.
applySystemProperties() - Method in class io.vertx.core.spi.launcher.DefaultCommand: Sets the system properties specified by the user command line.
argName - Variable in class io.vertx.core.cli.Argument: The argument name used in the usage.
argName - Variable in class io.vertx.core.cli.Option: the option name used in usage message.
argName() - Method in annotation type io.vertx.core.cli.annotations.Argument: The name of this argument (used in doc)
argName() - Method in annotation type io.vertx.core.cli.annotations.Option: The name of this argument (used in doc)
Argument - Class in io.vertx.core.cli: Defines a command line argument.
Argument - Annotation Type in io.vertx.core.cli.annotations: Annotates a setter to be called with the value of a command line argument.
Argument() - Constructor for class io.vertx.core.cli.Argument: Creates a new empty instance of Argument.
Argument(Argument) - Constructor for class io.vertx.core.cli.Argument: Creates a new instance of Argument by copying other.
Argument(JsonObject) - Constructor for class io.vertx.core.cli.Argument: Creates a new instance of Argument from the given JSON object.
ArgumentConverter - Class in io.vertx.core.cli: Converter and mapper for Argument.
ArgumentConverter() - Constructor for class io.vertx.core.cli.ArgumentConverter

B

beforeDeployingVerticle(DeploymentOptions) - Method in class io.vertx.core.Launcher: Hook for sub-classes of Launcher before the verticle is deployed.
beforeStartingVertx(VertxOptions) - Method in class io.vertx.core.Launcher: Hook for sub-classes of Launcher before the vertx instance is started.
beforeStoppingVertx(Vertx) - Method in class io.vertx.core.Launcher
BooleanConverter - Class in io.vertx.core.cli.converters: A converter for boolean.
buildWrapped(StringBuilder, int, String) - Method in class io.vertx.core.cli.UsageMessageFormatter: Builds the specified text to the specified buffer.
buildWrapped(StringBuilder, String) - Method in class io.vertx.core.cli.UsageMessageFormatter: Builds the specified text to the specified buffer.

C

CharacterConverter - Class in io.vertx.core.cli.converters: A converter for character.
choices - Variable in class io.vertx.core.cli.Option: if the option value has to be in a definited set, this field represents the set of values.
choices() - Method in annotation type io.vertx.core.cli.annotations.Option: The set of choices accepted as values by this option.
cli() - Method in interface io.vertx.core.cli.CommandLine
cli() - Method in class io.vertx.core.spi.launcher.ExecutionContext
CLI - Interface in io.vertx.core.cli: Interface defining a command-line interface (in other words a command such as 'run', 'ls'...).
CLIConfigurator - Class in io.vertx.core.cli.annotations: Class responsible for defining CLI using annotations and injecting values extracted by the parser.
CLIConfigurator() - Constructor for class io.vertx.core.cli.annotations.CLIConfigurator
CLIException - Exception in io.vertx.core.cli: High level exception thrown when an issue in the command line processing occurs.
CLIException(String) - Constructor for exception io.vertx.core.cli.CLIException: Creates a new instance of CLIException.
CLIException(String, Exception) - Constructor for exception io.vertx.core.cli.CLIException: Creates a new instance of CLIException.
command() - Method in class io.vertx.core.spi.launcher.ExecutionContext
Command - Interface in io.vertx.core.spi.launcher: A plug-in to the Vert.x command or Launcher class.
CommandFactory<C extends Command> - Interface in io.vertx.core.spi.launcher: SPI Interface to provide a new Launcher command.
CommandFactoryLookup - Interface in io.vertx.core.spi.launcher: The interface to implement to look for commands.
commandLine() - Method in class io.vertx.core.spi.launcher.ExecutionContext
CommandLine - Interface in io.vertx.core.cli: The parser transforms a CLI (a model) into an CommandLine.
computeOptionsAndArguments(StringBuilder, List<Option>, List<Argument>) - Method in class io.vertx.core.cli.UsageMessageFormatter: Computes the help for the specified Options to the specified writer.
computeUsage(StringBuilder, String) - Method in class io.vertx.core.cli.UsageMessageFormatter
computeUsageLine(StringBuilder, String, CLI) - Method in class io.vertx.core.cli.UsageMessageFormatter
ConstructorBasedConverter<T> - Class in io.vertx.core.cli.converters: This 'default' converter tries to create objects using a constructor taking a single String argument.
ConvertedBy - Annotation Type in io.vertx.core.cli.annotations: Annotates @Option setters to indicate how the value is converted to the argument type.
converter - Variable in class io.vertx.core.cli.TypedArgument: The converter to use to create the value.
converter - Variable in class io.vertx.core.cli.TypedOption: the converter to create the value.
Converter<T> - Interface in io.vertx.core.cli.converters: The converter interface to convert Strings to Objects.
Converters - Class in io.vertx.core.cli.converters: Entry point to the converter system.
Converters() - Constructor for class io.vertx.core.cli.converters.Converters
create(CLI) - Static method in interface io.vertx.core.cli.CommandLine: Creates a command line object from the CLI.
create(CommandLine) - Method in interface io.vertx.core.spi.launcher.CommandFactory
create(CommandLine) - Method in class io.vertx.core.spi.launcher.DefaultCommandFactory
create(Class<?>) - Static method in interface io.vertx.core.cli.CLI: Creates an instance of CLI from the given Java class.
create(Class<T>, String) - Static method in class io.vertx.core.cli.converters.Converters
create(String) - Static method in interface io.vertx.core.cli.CLI: Creates an instance of CLI using the default implementation.
create(String, Converter<T>) - Static method in class io.vertx.core.cli.converters.Converters
createPadding(int) - Static method in class io.vertx.core.cli.UsageMessageFormatter: Return a String of padding of length len.
createVertxBuilder(VertxOptions) - Method in class io.vertx.core.Launcher: Hook for sub-classes of Launcher to customize the Vert.x builder.

D

DEFAULT_ARG_NAME - Static variable in class io.vertx.core.cli.Argument: The default argument name displayed in the usage.
DEFAULT_ARG_NAME - Static variable in class io.vertx.core.cli.Option: Default name in the usage message.
DEFAULT_ARG_NAME - Static variable in class io.vertx.core.cli.UsageMessageFormatter: default name for an argument
DEFAULT_DESC_PAD - Static variable in class io.vertx.core.cli.UsageMessageFormatter: number of space characters to be prefixed to each description line
DEFAULT_LEFT_PAD - Static variable in class io.vertx.core.cli.UsageMessageFormatter: default padding to the left of each line
DEFAULT_LONG_OPT_PREFIX - Static variable in class io.vertx.core.cli.UsageMessageFormatter: default prefix for long Option
DEFAULT_LONG_OPT_SEPARATOR - Static variable in class io.vertx.core.cli.UsageMessageFormatter: default separator displayed between a long Option and its value
DEFAULT_OPT_PREFIX - Static variable in class io.vertx.core.cli.UsageMessageFormatter: default prefix for shortOpts
DEFAULT_USAGE_PREFIX - Static variable in class io.vertx.core.cli.UsageMessageFormatter: the string to display at the beginning of the usage statement
DEFAULT_WIDTH - Static variable in class io.vertx.core.cli.UsageMessageFormatter: default number of characters per line
DefaultCommand - Class in io.vertx.core.spi.launcher: Default implementation of Command using annotation to define itself.
DefaultCommand() - Constructor for class io.vertx.core.spi.launcher.DefaultCommand
DefaultCommandFactory<C extends Command> - Class in io.vertx.core.spi.launcher: Default implementation of CommandFactory.
DefaultCommandFactory(Class<C>) - Constructor for class io.vertx.core.spi.launcher.DefaultCommandFactory: Deprecated.
Please use DefaultCommandFactory(Class, Supplier)
DefaultCommandFactory(Class<C>, Supplier<C>) - Constructor for class io.vertx.core.spi.launcher.DefaultCommandFactory: Creates a new CommandFactory.
defaultValue - Variable in class io.vertx.core.cli.Argument: The optional default value of this argument.
defaultValue - Variable in class io.vertx.core.cli.Option: the option default value.
DefaultValue - Annotation Type in io.vertx.core.cli.annotations: Annotation to set a default value to an option.
define() - Method in interface io.vertx.core.spi.launcher.CommandFactory: Creates a new CLI instance.
define() - Method in class io.vertx.core.spi.launcher.DefaultCommandFactory
define(Class<?>) - Static method in class io.vertx.core.cli.annotations.CLIConfigurator: Creates an instance of the given class, and extracts the metadata from the given class.
description - Variable in class io.vertx.core.cli.Argument: The argument description.
description - Variable in class io.vertx.core.cli.Option: The option description.
Description - Annotation Type in io.vertx.core.cli.annotations: Annotation used to write the option or command documentation.

E

ensureValidity() - Method in class io.vertx.core.cli.Argument: Checks that the argument configuration is valid.
ensureValidity() - Method in class io.vertx.core.cli.Option: Checks whether or not the option is valid.
ensureValidity() - Method in class io.vertx.core.cli.TypedArgument: Checks whether or not the argument configuration is valid.
ensureValidity() - Method in class io.vertx.core.cli.TypedOption
execute(String, String...) - Method in class io.vertx.core.spi.launcher.ExecutionContext: Executes another command.
executeCommand(String, String...) - Static method in class io.vertx.core.Launcher: Utility method to execute a specific command.
executionContext - Variable in class io.vertx.core.spi.launcher.DefaultCommand: The execution context of the command.
ExecutionContext - Class in io.vertx.core.spi.launcher: The execution context contains various information on the execution.
ExecutionContext(Command, VertxCommandLauncher, CommandLine) - Constructor for class io.vertx.core.spi.launcher.ExecutionContext: Creates a new instance of ExecutionContext.

F

findWrapPos(String, int, int) - Static method in class io.vertx.core.cli.UsageMessageFormatter: Finds the next text wrap position after startPos for the text in text with the column width width.
flag - Variable in class io.vertx.core.cli.Option: whether or not the option is a flag.
flag() - Method in annotation type io.vertx.core.cli.annotations.Option: Whether or not the option can be used as a flag (meaning no value)
FROM - Static variable in class io.vertx.core.cli.converters.FromBasedConverter
FROM_STRING - Static variable in class io.vertx.core.cli.converters.FromStringBasedConverter
FromBasedConverter<T> - Class in io.vertx.core.cli.converters: This 'default' converter tries to create objects using a static 'from' method taking a single String argument.
fromString(String) - Method in class io.vertx.core.cli.converters.BooleanConverter: Creates the boolean value from the given String.
fromString(String) - Method in class io.vertx.core.cli.converters.CharacterConverter
fromString(String) - Method in class io.vertx.core.cli.converters.ConstructorBasedConverter: Converts the given input to an object by using the constructor approach.
fromString(String) - Method in interface io.vertx.core.cli.converters.Converter
fromString(String) - Method in class io.vertx.core.cli.converters.FromBasedConverter: Converts the given input to an object by using the 'from' method.
fromString(String) - Method in class io.vertx.core.cli.converters.FromStringBasedConverter: Converts the given input to an object by using the 'fromString' method.
fromString(String) - Method in class io.vertx.core.cli.converters.ValueOfBasedConverter: Converts the given input to an object by using the 'valueOf' method.
FromStringBasedConverter<T> - Class in io.vertx.core.cli.converters: This 'default' converter tries to create objects using a static 'from' method taking a single String argument.

G

getArgName() - Method in class io.vertx.core.cli.Argument
getArgName() - Method in class io.vertx.core.cli.Option
getArgName() - Method in class io.vertx.core.cli.UsageMessageFormatter
getArgument() - Method in exception io.vertx.core.cli.InvalidValueException
getArgument() - Method in exception io.vertx.core.cli.MissingValueException
getArgument(int) - Method in interface io.vertx.core.cli.CLI: Gets an Argument based on its index.
getArgument(String) - Method in interface io.vertx.core.cli.CLI: Gets an Argument based on its name (argument name).
getArguments() - Method in interface io.vertx.core.cli.CLI: Gets the list of defined arguments.
getArgumentValue(int) - Method in interface io.vertx.core.cli.CommandLine: Gets the value of an argument with the given index.
getArgumentValue(String) - Method in interface io.vertx.core.cli.CommandLine: Gets the value of an argument with the matching name (arg name).
getArgumentValues(int) - Method in interface io.vertx.core.cli.CommandLine: Gets the values of an argument with the matching index.
getChoices() - Method in class io.vertx.core.cli.Option
getConverter() - Method in class io.vertx.core.cli.TypedArgument
getConverter() - Method in class io.vertx.core.cli.TypedOption
getCwd() - Method in class io.vertx.core.spi.launcher.DefaultCommand
getDefaultValue() - Method in class io.vertx.core.cli.Argument
getDefaultValue() - Method in class io.vertx.core.cli.Option
getDescPadding() - Method in class io.vertx.core.cli.UsageMessageFormatter
getDescription() - Method in class io.vertx.core.cli.Argument
getDescription() - Method in interface io.vertx.core.cli.CLI
getDescription() - Method in class io.vertx.core.cli.Option
getExpected() - Method in exception io.vertx.core.cli.MissingOptionException
getIfEligible(Class<T>) - Static method in class io.vertx.core.cli.converters.ConstructorBasedConverter: Checks whether the given class can be used by the ConstructorBasedConverter (i.e. has a constructor taking a single String as argument).
getIfEligible(Class<T>) - Static method in class io.vertx.core.cli.converters.FromBasedConverter: Checks whether the given class can be used by the FromBasedConverter (i.e. has a static 'from' method taking a single String as argument).
getIfEligible(Class<T>) - Static method in class io.vertx.core.cli.converters.FromStringBasedConverter: Checks whether the given class can be used by the FromStringBasedConverter (i.e. has a static 'fromString' method taking a single String as argument).
getIfEligible(Class<T>) - Static method in class io.vertx.core.cli.converters.ValueOfBasedConverter: Checks whether the given class can be used by the ValueOfBasedConverter (i.e. has a static 'valueOf' method taking a single String as argument).
getIndex() - Method in class io.vertx.core.cli.Argument
getLeftPadding() - Method in class io.vertx.core.cli.UsageMessageFormatter
getListSeparator() - Method in class io.vertx.core.cli.TypedOption
getLongName() - Method in class io.vertx.core.cli.Option
getLongOptionPrefix() - Method in class io.vertx.core.cli.UsageMessageFormatter
getLongOptionSeparator() - Method in class io.vertx.core.cli.UsageMessageFormatter: Returns the separator displayed between a long option and its value.
getName() - Method in interface io.vertx.core.cli.CLI
getName() - Method in class io.vertx.core.cli.Option
getNewLine() - Method in class io.vertx.core.cli.UsageMessageFormatter
getOption() - Method in exception io.vertx.core.cli.InvalidValueException
getOption() - Method in exception io.vertx.core.cli.MissingValueException
getOption(String) - Method in interface io.vertx.core.cli.CLI: Gets an Option based on its name (short name, long name or argument name).
getOptionComparator() - Method in class io.vertx.core.cli.UsageMessageFormatter: Comparator used to sort the options when they output in help text.
getOptionPrefix() - Method in class io.vertx.core.cli.UsageMessageFormatter
getOptions() - Method in exception io.vertx.core.cli.AmbiguousOptionException
getOptions() - Method in interface io.vertx.core.cli.CLI: Gets the list of options.
getOptionValue(String) - Method in interface io.vertx.core.cli.CommandLine: Gets the value of an option with the matching name (can be the long name, short name or arg name).
getOptionValues(String) - Method in interface io.vertx.core.cli.CommandLine: Gets the values of an option with the matching name (can be the long name, short name or arg name).
getPrintStream() - Method in class io.vertx.core.spi.launcher.ExecutionContext
getPriority() - Method in interface io.vertx.core.cli.CLI
getRawValueForArgument(Argument) - Method in interface io.vertx.core.cli.CommandLine: Gets the raw value of the given argument.
getRawValueForOption(Option) - Method in interface io.vertx.core.cli.CommandLine: Gets the raw value of the given option.
getRawValues(Option) - Method in interface io.vertx.core.cli.CommandLine: Deprecated.
use CommandLine.getRawValuesForOption(Option)
getRawValuesForArgument(Argument) - Method in interface io.vertx.core.cli.CommandLine: Gets the raw values of the given argument.
getRawValuesForOption(Option) - Method in interface io.vertx.core.cli.CommandLine: Gets the raw values of the given option.
getShortName() - Method in class io.vertx.core.cli.Option
getSummary() - Method in interface io.vertx.core.cli.CLI
getToken() - Method in exception io.vertx.core.cli.AmbiguousOptionException
getType() - Method in class io.vertx.core.cli.TypedArgument
getType() - Method in class io.vertx.core.cli.TypedOption
getUsagePrefix() - Method in class io.vertx.core.cli.UsageMessageFormatter
getValue() - Method in exception io.vertx.core.cli.InvalidValueException
getWidth() - Method in class io.vertx.core.cli.UsageMessageFormatter

H

handleDeployFailed(Vertx, String, DeploymentOptions, Throwable) - Method in class io.vertx.core.Launcher: A deployment failure has been encountered.
help - Variable in class io.vertx.core.cli.Option: whether or not the option is a "help" option.
help() - Method in annotation type io.vertx.core.cli.annotations.Option: Whether or not this option is a "Help" option.
hidden - Variable in class io.vertx.core.cli.Argument: Whether or not this argument is hidden.
hidden - Variable in class io.vertx.core.cli.Option: whether or not the option is hidden.
Hidden - Annotation Type in io.vertx.core.cli.annotations: Annotates a CLI and/or its @Option setters to hide it from the help message.

I

index - Variable in class io.vertx.core.cli.Argument: The argument index.
index() - Method in annotation type io.vertx.core.cli.annotations.Argument: The (0-based) position of this argument relative to the argument list.
inject(CommandLine, Object) - Static method in class io.vertx.core.cli.annotations.CLIConfigurator: Injects the value in the annotated setter methods (Option and Argument.
INSTANCE - Static variable in class io.vertx.core.cli.converters.BooleanConverter: The converter.
INSTANCE - Static variable in class io.vertx.core.cli.converters.CharacterConverter: The converter.
InvalidValueException - Exception in io.vertx.core.cli: Exception thrown when an option or an argument receives an invalid value.
InvalidValueException(Argument, String, Exception) - Constructor for exception io.vertx.core.cli.InvalidValueException: Creates a new instance of InvalidValueException for the given argument and the given value.
InvalidValueException(Option, String) - Constructor for exception io.vertx.core.cli.InvalidValueException: Creates a new instance of InvalidValueException for the given option and the given value.
InvalidValueException(Option, String, Exception) - Constructor for exception io.vertx.core.cli.InvalidValueException: Creates a new instance of InvalidValueException for the given option and the given value.
io.vertx.core - package io.vertx.core
io.vertx.core.cli - package io.vertx.core.cli
io.vertx.core.cli.annotations - package io.vertx.core.cli.annotations
io.vertx.core.cli.converters - package io.vertx.core.cli.converters
io.vertx.core.spi.launcher - package io.vertx.core.spi.launcher
isArgumentAssigned(Argument) - Method in interface io.vertx.core.cli.CommandLine: Checks whether or not the given argument has been assigned in the command line.
isAskingForHelp() - Method in interface io.vertx.core.cli.CommandLine: Checks whether or not the user has passed a "help" option and is asking for help.
isFlag() - Method in class io.vertx.core.cli.Option
isFlagEnabled(String) - Method in interface io.vertx.core.cli.CommandLine: Gets the value of an option marked as a flag.
isHelp() - Method in class io.vertx.core.cli.Option: Checks whether or not this option is a "Help" option.
isHidden() - Method in class io.vertx.core.cli.Argument
isHidden() - Method in interface io.vertx.core.cli.CLI: Checks whether or not the current CLI instance is hidden.
isHidden() - Method in class io.vertx.core.cli.Option
isMultiValued() - Method in class io.vertx.core.cli.Argument
isMultiValued() - Method in class io.vertx.core.cli.Option
isNullOrEmpty(String) - Static method in class io.vertx.core.cli.UsageMessageFormatter
isOptionAssigned(Option) - Method in interface io.vertx.core.cli.CommandLine: Checks whether or not the given option has been assigned in the command line.
isParsedAsList() - Method in class io.vertx.core.cli.TypedOption
isRequired() - Method in class io.vertx.core.cli.Argument
isRequired() - Method in class io.vertx.core.cli.Option
isSeenInCommandLine(Option) - Method in interface io.vertx.core.cli.CommandLine: Checks whether or not the given option has been seen in the user command line.
isSingleValued() - Method in class io.vertx.core.cli.Option
isValid() - Method in interface io.vertx.core.cli.CommandLine: Checks whether or not the command line is valid, i.e. all constraints from arguments and options have been satisfied.

L

launcher() - Method in class io.vertx.core.spi.launcher.ExecutionContext
Launcher - Class in io.vertx.core: A main() class that can be used to create Vert.x instance and deploy a verticle, or run a bare Vert.x instance.
Launcher() - Constructor for class io.vertx.core.Launcher
listSeparator - Variable in class io.vertx.core.cli.TypedOption: the split character used if the raw value needs to be parsed as a list.
longName - Variable in class io.vertx.core.cli.Option: the option long name.
longName() - Method in annotation type io.vertx.core.cli.annotations.Option: The name of the option (without the -- prefix).
lookup() - Method in interface io.vertx.core.spi.launcher.CommandFactoryLookup: Looks for command implementation and instantiated them.

M

main() - Method in class io.vertx.core.spi.launcher.ExecutionContext
main(String[]) - Static method in class io.vertx.core.Launcher: Main entry point.
MissingOptionException - Exception in io.vertx.core.cli: Exception thrown when an option was expected and was not found on the command line.
MissingOptionException(Collection<Option>) - Constructor for exception io.vertx.core.cli.MissingOptionException: Creates a new instance of MissingOptionException.
MissingValueException - Exception in io.vertx.core.cli: Exception thrown when an option requiring a value does not receive the value, or when a mandatory argument does not receive a value.
MissingValueException(Argument) - Constructor for exception io.vertx.core.cli.MissingValueException: Creates a new instance of MissingValueException when a mandatory argument is not set in the user command line.
MissingValueException(Option) - Constructor for exception io.vertx.core.cli.MissingValueException: Creates a new instance of MissingValueException when an option requiring a value does not receive a value.
multiValued - Variable in class io.vertx.core.cli.Argument: Whether or not this argument can receive multiple value.
multiValued - Variable in class io.vertx.core.cli.Option: whether or not the option can recevie multiple values.

N

Name - Annotation Type in io.vertx.core.cli.annotations: Defines the name of a CLI.
newInstance(Class<? extends Converter<T>>) - Static method in class io.vertx.core.cli.converters.Converters
NO_NAME - Static variable in annotation type io.vertx.core.cli.annotations.Option
NO_NAME - Static variable in class io.vertx.core.cli.Option: The default long name / short name of the option.

O

Option - Class in io.vertx.core.cli: Models command line options.
Option - Annotation Type in io.vertx.core.cli.annotations: Annotates a setter to be called with the value of a command line option.
Option() - Constructor for class io.vertx.core.cli.Option: Creates a new empty instance of Option.
Option(Option) - Constructor for class io.vertx.core.cli.Option: Creates a new instance of Option by copying the state of another Option.
Option(JsonObject) - Constructor for class io.vertx.core.cli.Option: Creates a new instance of Option from the given JsonObject
optionComparator - Variable in class io.vertx.core.cli.UsageMessageFormatter: Comparator used to sort the options when they output in help text
OptionConverter - Class in io.vertx.core.cli: Converter and mapper for Option.
OptionConverter() - Constructor for class io.vertx.core.cli.OptionConverter
out - Variable in class io.vertx.core.spi.launcher.DefaultCommand: The PrintStream that the command can use to write on the console.
out() - Method in class io.vertx.core.spi.launcher.DefaultCommand

P

parse(List<String>) - Method in interface io.vertx.core.cli.CLI: Parses the user command line interface and create a new CommandLine containing extracting values.
parse(List<String>, boolean) - Method in interface io.vertx.core.cli.CLI: Parses the user command line interface and create a new CommandLine containing extracting values.
parsedAsList - Variable in class io.vertx.core.cli.TypedOption: whether or not the raw value should be parsed as a list.
ParsedAsList - Annotation Type in io.vertx.core.cli.annotations: Annotates a setter to be called with the value of a command line option.
priority() - Method in annotation type io.vertx.core.cli.annotations.Name: The command priority.

R

removeArgument(int) - Method in interface io.vertx.core.cli.CLI: Removes an argument identified by its index.
removeOption(String) - Method in interface io.vertx.core.cli.CLI: Removes an option identified by its name.
renderCommands(StringBuilder, Collection<CLI>) - Method in class io.vertx.core.cli.UsageMessageFormatter
renderOptionsAndArguments(StringBuilder, List<Option>, List<Argument>) - Method in class io.vertx.core.cli.UsageMessageFormatter: Renders the specified Options and Arguments and return the rendered output in a StringBuilder.
renderWrappedText(StringBuilder, int, int, String) - Method in class io.vertx.core.cli.UsageMessageFormatter: Render the specified text and return the rendered Options in a StringBuilder.
renderWrappedTextBlock(StringBuilder, int, int, String) - Method in class io.vertx.core.cli.UsageMessageFormatter: Renders the specified text width a maximum width.
required - Variable in class io.vertx.core.cli.Argument: Whether or not this argument is mandatory.
required - Variable in class io.vertx.core.cli.Option: whether or not the option is required.
required() - Method in annotation type io.vertx.core.cli.annotations.Argument: Whether or not the argument is required.
required() - Method in annotation type io.vertx.core.cli.annotations.Option: Whether or not the option is required.
rtrim(String) - Static method in class io.vertx.core.cli.UsageMessageFormatter: Remove the trailing whitespace from the specified String.
run() - Method in interface io.vertx.core.spi.launcher.Command: Executes the command.

S

separator() - Method in annotation type io.vertx.core.cli.annotations.ParsedAsList: The separator used to split the value.
setArgName(String) - Method in class io.vertx.core.cli.Argument: Sets the argument name of this Argument.
setArgName(String) - Method in class io.vertx.core.cli.Option: Sets te arg name for this option.
setArgName(String) - Method in class io.vertx.core.cli.TypedArgument
setArgName(String) - Method in class io.vertx.core.cli.TypedOption
setArgName(String) - Method in class io.vertx.core.cli.UsageMessageFormatter
setArguments(List<Argument>) - Method in interface io.vertx.core.cli.CLI: Sets the list of arguments.
setChoices(Set<String>) - Method in class io.vertx.core.cli.Option: Sets the list of values accepted by this option.
setChoices(Set<String>) - Method in class io.vertx.core.cli.TypedOption
setConverter(Converter<T>) - Method in class io.vertx.core.cli.TypedArgument: Sets the converter used to create the value.
setConverter(Converter<T>) - Method in class io.vertx.core.cli.TypedOption
setCwd(File) - Method in class io.vertx.core.spi.launcher.DefaultCommand: Sets the current working directory.
setDefaultValue(String) - Method in class io.vertx.core.cli.Argument: Sets the default value of this Argument.
setDefaultValue(String) - Method in class io.vertx.core.cli.Option: Sets the default value of this option
setDefaultValue(String) - Method in class io.vertx.core.cli.TypedArgument
setDefaultValue(String) - Method in class io.vertx.core.cli.TypedOption
setDescPadding(int) - Method in class io.vertx.core.cli.UsageMessageFormatter
setDescription(String) - Method in class io.vertx.core.cli.Argument: Sets the description of the Argument.
setDescription(String) - Method in interface io.vertx.core.cli.CLI
setDescription(String) - Method in class io.vertx.core.cli.Option: Sets te description of this option.
setDescription(String) - Method in class io.vertx.core.cli.TypedArgument
setDescription(String) - Method in class io.vertx.core.cli.TypedOption
setFlag(boolean) - Method in class io.vertx.core.cli.Option: Configures the current Option to be a flag.
setFlag(boolean) - Method in class io.vertx.core.cli.TypedOption
setHelp(boolean) - Method in class io.vertx.core.cli.Option: Sets whether or not this option is a "help" option
setHidden(boolean) - Method in class io.vertx.core.cli.Argument: Sets whether or not the current Argument is hidden.
setHidden(boolean) - Method in interface io.vertx.core.cli.CLI: Sets whether or not the current instance of CLI must be hidden.
setHidden(boolean) - Method in class io.vertx.core.cli.Option: Sets whether or not this option should be hidden
setHidden(boolean) - Method in class io.vertx.core.cli.TypedArgument
setHidden(boolean) - Method in class io.vertx.core.cli.TypedOption
setIndex(int) - Method in class io.vertx.core.cli.Argument: Sets the argument index.
setIndex(int) - Method in class io.vertx.core.cli.TypedArgument
setLeftPadding(int) - Method in class io.vertx.core.cli.UsageMessageFormatter
setListSeparator(String) - Method in class io.vertx.core.cli.TypedOption
setLongName(String) - Method in class io.vertx.core.cli.Option: Sets the long name of this option.
setLongName(String) - Method in class io.vertx.core.cli.TypedOption
setLongOptionPrefix(String) - Method in class io.vertx.core.cli.UsageMessageFormatter
setLongOptionSeparator(String) - Method in class io.vertx.core.cli.UsageMessageFormatter: Set the separator displayed between a long option and its value.
setMultiValued(boolean) - Method in class io.vertx.core.cli.Argument: Sets whether or not the argument can receive several values.
setMultiValued(boolean) - Method in class io.vertx.core.cli.Option: Sets whether or not this option can receive several values.
setMultiValued(boolean) - Method in class io.vertx.core.cli.TypedArgument
setMultiValued(boolean) - Method in class io.vertx.core.cli.TypedOption
setName(String) - Method in interface io.vertx.core.cli.CLI: Sets the name of the CLI.
setNewLine(String) - Method in class io.vertx.core.cli.UsageMessageFormatter
setOptionComparator(Comparator<Option>) - Method in class io.vertx.core.cli.UsageMessageFormatter: Set the comparator used to sort the options when they output in help text.
setOptionPrefix(String) - Method in class io.vertx.core.cli.UsageMessageFormatter
setOptions(List<Option>) - Method in interface io.vertx.core.cli.CLI: Sets the list of arguments.
setParsedAsList(boolean) - Method in class io.vertx.core.cli.TypedOption
setPriority(int) - Method in interface io.vertx.core.cli.CLI: Sets the priority of the CLI.
setRequired(boolean) - Method in class io.vertx.core.cli.Argument: Sets whether or not the current Argument is required.
setRequired(boolean) - Method in class io.vertx.core.cli.Option: Sets whether or not this option is mandatory.
setRequired(boolean) - Method in class io.vertx.core.cli.TypedArgument
setRequired(boolean) - Method in class io.vertx.core.cli.TypedOption
setShortName(String) - Method in class io.vertx.core.cli.Option: Sets the short name of this option.
setShortName(String) - Method in class io.vertx.core.cli.TypedOption
setSingleValued(boolean) - Method in class io.vertx.core.cli.Option: Sets whether or not this option can receive a value.
setSingleValued(boolean) - Method in class io.vertx.core.cli.TypedOption
setSummary(String) - Method in interface io.vertx.core.cli.CLI: Sets the summary of the CLI.
setSystemProps(List<String>) - Method in class io.vertx.core.spi.launcher.DefaultCommand: Gets system properties passed in the user command line.
setType(Class<T>) - Method in class io.vertx.core.cli.TypedArgument: Sets the argument type.
setType(Class<T>) - Method in class io.vertx.core.cli.TypedOption
setUp(ExecutionContext) - Method in interface io.vertx.core.spi.launcher.Command: Set up the command execution environment.
setUp(ExecutionContext) - Method in class io.vertx.core.spi.launcher.DefaultCommand
setUsagePrefix(String) - Method in class io.vertx.core.cli.UsageMessageFormatter
setWidth(int) - Method in class io.vertx.core.cli.UsageMessageFormatter
shortName - Variable in class io.vertx.core.cli.Option: the option short name.
shortName() - Method in annotation type io.vertx.core.cli.annotations.Option: The short option name (without the - prefix).
singleValued - Variable in class io.vertx.core.cli.Option: whether or not the option receives a single value.
Summary - Annotation Type in io.vertx.core.cli.annotations: Annotates a CLI with summary.
systemProperties - Variable in class io.vertx.core.spi.launcher.DefaultCommand

T

tearDown() - Method in interface io.vertx.core.spi.launcher.Command: The command has been executed.
tearDown() - Method in class io.vertx.core.spi.launcher.DefaultCommand
toJson() - Method in class io.vertx.core.cli.Argument: Exports this Argument to its corresponding JSON representation.
toJson() - Method in class io.vertx.core.cli.Option: Gets the json representation of this Option.
type - Variable in class io.vertx.core.cli.TypedArgument: The type of the argument.
type - Variable in class io.vertx.core.cli.TypedOption: The type of the option.
TypedArgument<T> - Class in io.vertx.core.cli: An implementation of Argument for java specifying the type of object received by the argument.
TypedArgument() - Constructor for class io.vertx.core.cli.TypedArgument: Creates an empty instance of TypedArgument.
TypedArgument(TypedArgument<T>) - Constructor for class io.vertx.core.cli.TypedArgument: Creates a new instance of TypedArgument by copying the state of another TypedArgument.
TypedOption<T> - Class in io.vertx.core.cli: An implementation of Option for java specifying the type of object received by the option.
TypedOption() - Constructor for class io.vertx.core.cli.TypedOption: Creates an empty instance of TypedOption.
TypedOption(TypedOption<T>) - Constructor for class io.vertx.core.cli.TypedOption: Creates an instance of TypedOption by copying the state of another TypedOption

U

usage(StringBuilder) - Method in interface io.vertx.core.cli.CLI: Generates the usage / help of the current CLI.
usage(StringBuilder, CLI) - Method in class io.vertx.core.cli.UsageMessageFormatter: Computes the usage of the given CLI.
usage(StringBuilder, String) - Method in interface io.vertx.core.cli.CLI: Generates the usage / help of the current CLI.
usage(StringBuilder, String, CLI) - Method in class io.vertx.core.cli.UsageMessageFormatter: Computes the usage of the given CLI.
UsageMessageFormatter - Class in io.vertx.core.cli: Usage message formatter.
UsageMessageFormatter() - Constructor for class io.vertx.core.cli.UsageMessageFormatter

V

value() - Method in annotation type io.vertx.core.cli.annotations.ConvertedBy: The converter class used to transform the value as String to the target type.
value() - Method in annotation type io.vertx.core.cli.annotations.DefaultValue: The (optional) default value of the option.
value() - Method in annotation type io.vertx.core.cli.annotations.Description: The documentation.
value() - Method in annotation type io.vertx.core.cli.annotations.Name: The command name.
value() - Method in annotation type io.vertx.core.cli.annotations.Summary: The summary.
VALUE_OF - Static variable in class io.vertx.core.cli.converters.ValueOfBasedConverter
ValueOfBasedConverter<T> - Class in io.vertx.core.cli.converters: This 'default' converter tries to create objects using a static 'valueOf' method taking a single String argument.

A B C D E F G H I L M N O P R S T U V
All Classes All Packages