Package io.vertx.reactivex.core.cli

Class 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 using Option, while argument are defined using Argument.

    Command line interfaces also define a summary and a description. These attributes are used in the usage generation . To disable the help generation, set the hidden attribute to true.

    Command Line Interface object does not contains "value", it's a model. It must be evaluated by a parser that returns a CommandLine object containing the argument and option values.

    NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

    • Field Detail

      • __TYPE_ARG

        public static final TypeArg<CLI> __TYPE_ARG

    • Constructor Detail

      • CLI

        public CLI​(CLI delegate)

      • CLI

        public CLI​(Object delegate)

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getDelegate

        public CLI getDelegate()

      • create

        public static CLI create​(String name)
        Creates an instance of CLI using the default implementation.
        Parameters:
        name - the name of the CLI (must not be null)
        Returns:
        the created instance of CLI

      • parse

        public CommandLine parse​(List<String> arguments)
        Parses the user command line interface and create a new CommandLine 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 new CommandLine containing extracting values.
        Parameters:
        arguments - the arguments
        validate - 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.

      • setDescription

        public CLI setDescription​(String desc)

      • 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 current CLI instance is hidden.
        Returns:
        true if the current CLI is hidden, otherwise

      • setHidden

        public CLI setHidden​(boolean hidden)
        Sets whether or not the current instance of CLI 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 be null.
        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 be null
        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 be null
        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 be null
        Returns:
        the current CLI instance

      • getOption

        public Option getOption​(String name)
        Gets an Option based on its name (short name, long name or argument name).
        Parameters:
        name - the name, must not be null
        Returns:
        the Option, null if not found

      • getArgument

        public Argument getArgument​(String name)
        Gets an Argument based on its name (argument name).
        Parameters:
        name - the name of the argument, must not be null
        Returns:
        the Argument, null if not found.

      • getArgument

        public Argument getArgument​(int index)
        Gets an Argument 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

      • newInstance

        public static CLI newInstance​(CLI arg)