Package io.vertx.rxjava3.ext.shell.command

Class CommandRegistry

  • All Implemented Interfaces:
    RxDelegate
    public class CommandRegistry
extends CommandResolver
implements RxDelegate
    A registry that contains the commands known by a shell.

    It is a mutable command resolver.

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

    • Constructor Detail

      • CommandRegistry

        public CommandRegistry​(Object delegate)

    • Method Detail

      • getShared

        public static CommandRegistry getShared​(Vertx vertx)
        Get the shared registry for the Vert.x instance.
        Parameters:
        vertx - the vertx instance
        Returns:
        the shared registry

      • create

        public static CommandRegistry create​(Vertx vertx)
        Create a new registry.
        Parameters:
        vertx - the vertx instance
        Returns:
        the created registry

      • registerCommand

        public io.reactivex.rxjava3.core.Single<Command> registerCommand​(Command command)
        Register a command
        Parameters:
        command - the command to register
        Returns:
        a reference to this, so the API can be used fluently

      • rxRegisterCommand

        public io.reactivex.rxjava3.core.Single<Command> rxRegisterCommand​(Command command)
        Register a command
        Parameters:
        command - the command to register
        Returns:
        a reference to this, so the API can be used fluently

      • registerCommands

        public io.reactivex.rxjava3.core.Single<List<Command>> registerCommands​(List<Command> commands)
        Register a list of commands.
        Parameters:
        commands - the commands to register
        Returns:
        a reference to this, so the API can be used fluently

      • rxRegisterCommands

        public io.reactivex.rxjava3.core.Single<List<Command>> rxRegisterCommands​(List<Command> commands)
        Register a list of commands.
        Parameters:
        commands - the commands to register
        Returns:
        a reference to this, so the API can be used fluently

      • unregisterCommand

        public io.reactivex.rxjava3.core.Completable unregisterCommand​(String commandName)
        Unregister a command.
        Parameters:
        commandName - the command name
        Returns:
        a reference to this, so the API can be used fluently

      • rxUnregisterCommand

        public io.reactivex.rxjava3.core.Completable rxUnregisterCommand​(String commandName)
        Unregister a command.
        Parameters:
        commandName - the command name
        Returns:
        a reference to this, so the API can be used fluently