Package io.vertx.rxjava.core.cli
Class CLI
- java.lang.Object
-
- io.vertx.rxjava.core.cli.CLI
-
public class CLI extends Object
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 usingOption
, while argument are defined usingArgument
. Command line interfaces also define a summary and a description. These attributes are used in the usage generation . To disable the help generation, set thehidden
attribute totrue
. Command Line Interface object does not contains "value", it's a model. It must be evaluated by a parser that returns aCommandLine
object containing the argument and option values. NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<CLI>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CLI
addArgument(Argument arg)
Adds an argument.CLI
addArguments(List<Argument> args)
Adds a set of arguments.CLI
addOption(Option option)
Adds an option.CLI
addOptions(List<Option> options)
Adds a set of options.static CLI
create(String name)
Creates an instance ofCLI
using the default implementation.boolean
equals(Object o)
Argument
getArgument(int index)
Gets anArgument
based on its index.Argument
getArgument(String name)
Gets anArgument
based on its name (argument name).List<Argument>
getArguments()
Gets the list of defined arguments.CLI
getDelegate()
String
getDescription()
String
getName()
Option
getOption(String name)
Gets anOption
based on its name (short name, long name or argument name).List<Option>
getOptions()
Gets the list of options.int
getPriority()
String
getSummary()
int
hashCode()
boolean
isHidden()
Checks whether or not the currentCLI
instance is hidden.static CLI
newInstance(CLI arg)
CommandLine
parse(List<String> arguments)
Parses the user command line interface and create a newCommandLine
containing extracting values.CommandLine
parse(List<String> arguments, boolean validate)
Parses the user command line interface and create a newCommandLine
containing extracting values.CLI
removeArgument(int index)
Removes an argument identified by its index.CLI
removeOption(String name)
Removes an option identified by its name.CLI
setArguments(List<Argument> args)
Sets the list of arguments.CLI
setDescription(String desc)
CLI
setHidden(boolean hidden)
Sets whether or not the current instance ofCLI
must be hidden.CLI
setName(String name)
Sets the name of the CLI.CLI
setOptions(List<Option> options)
Sets the list of arguments.CLI
setPriority(int priority)
Sets the priority of the CLI.CLI
setSummary(String summary)
Sets the summary of the CLI.String
toString()
-
-
-
Method Detail
-
getDelegate
public CLI getDelegate()
-
create
public static CLI create(String name)
Creates an instance ofCLI
using the default implementation.- Parameters:
name
- the name of the CLI (must not benull
)- Returns:
- the created instance of
CLI
-
parse
public CommandLine parse(List<String> arguments)
Parses the user command line interface and create a newCommandLine
containing extracting values.- Parameters:
arguments
- the arguments- Returns:
- the creates command line
-
parse
public CommandLine parse(List<String> arguments, boolean validate)
Parses the user command line interface and create a newCommandLine
containing extracting values.- Parameters:
arguments
- the argumentsvalidate
- enable / disable parsing validation- Returns:
- the creates command line
-
getName
public String getName()
- Returns:
- the CLI name.
-
setName
public CLI setName(String name)
Sets the name of the CLI.- Parameters:
name
- the name- Returns:
- the current
CLI
instance
-
getDescription
public String getDescription()
- Returns:
- the CLI description.
-
getSummary
public String getSummary()
- Returns:
- the CLI summary.
-
setSummary
public CLI setSummary(String summary)
Sets the summary of the CLI.- Parameters:
summary
- the summary- Returns:
- the current
CLI
instance
-
isHidden
public boolean isHidden()
Checks whether or not the currentCLI
instance is hidden.- Returns:
true
if the currentCLI
is hidden, otherwise
-
setHidden
public CLI setHidden(boolean hidden)
Sets whether or not the current instance ofCLI
must be hidden. Hidden CLI are not listed when displaying usages / help messages. In other words, hidden commands are for power user.- Parameters:
hidden
- enables or disables the hidden aspect of the CI- Returns:
- the current
CLI
instance
-
getOptions
public List<Option> getOptions()
Gets the list of options.- Returns:
- the list of options, empty if none.
-
addOption
public CLI addOption(Option option)
Adds an option.- Parameters:
option
- the option, must not benull
.- Returns:
- the current
CLI
instance
-
addOptions
public CLI addOptions(List<Option> options)
Adds a set of options. UnlikesetOptions(java.util.List<io.vertx.core.cli.Option>)
}, this method does not remove the existing options. The given list is appended to the existing list.- Parameters:
options
- the options, must not benull
- Returns:
- the current
CLI
instance
-
setOptions
public CLI setOptions(List<Option> options)
Sets the list of arguments.- Parameters:
options
- the list of options, must not benull
- Returns:
- the current
CLI
instance
-
getArguments
public List<Argument> getArguments()
Gets the list of defined arguments.- Returns:
- the list of argument, empty if none.
-
addArgument
public CLI addArgument(Argument arg)
Adds an argument.- Parameters:
arg
- the argument, must not benull
- Returns:
- the current
CLI
instance
-
addArguments
public CLI addArguments(List<Argument> args)
Adds a set of arguments. UnlikesetArguments(java.util.List<io.vertx.core.cli.Argument>)
, this method does not remove the existing arguments. The given list is appended to the existing list.- Parameters:
args
- the arguments, must not benull
- Returns:
- the current
CLI
instance
-
setArguments
public CLI setArguments(List<Argument> args)
Sets the list of arguments.- Parameters:
args
- the list of arguments, must not benull
- Returns:
- the current
CLI
instance
-
getOption
public Option getOption(String name)
Gets anOption
based on its name (short name, long name or argument name).- Parameters:
name
- the name, must not benull
- Returns:
- the
Option
,null
if not found
-
getArgument
public Argument getArgument(String name)
Gets anArgument
based on its name (argument name).- Parameters:
name
- the name of the argument, must not benull
- Returns:
- the
Argument
,null
if not found.
-
getArgument
public Argument getArgument(int index)
Gets anArgument
based on its index.- Parameters:
index
- the index, must be positive or zero.- Returns:
- the
Argument
,null
if not found.
-
removeOption
public CLI removeOption(String name)
Removes an option identified by its name. This method does nothing if the option cannot be found.- Parameters:
name
- the option name- Returns:
- the current
CLI
instance
-
removeArgument
public CLI removeArgument(int index)
Removes an argument identified by its index. This method does nothing if the argument cannot be found.- Parameters:
index
- the argument index- Returns:
- the current
CLI
instance
-
getPriority
public int getPriority()
- Returns:
- the CLI priority.
-
setPriority
public CLI setPriority(int priority)
Sets the priority of the CLI.- Parameters:
priority
- the priority- Returns:
- the current
CLI
instance
-
-