Class CommandRegistryAdapter

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> commandAliases()
      Returns a map of alias-to-command names known by this registry.
      CmdDesc commandDescription​(java.util.List<java.lang.String> args)
      Returns a command description for use in the JLine Widgets framework.
      java.util.List<java.lang.String> commandInfo​(java.lang.String command)
      Returns a short info about command known by this registry.
      java.util.Set<java.lang.String> commandNames()
      Returns the command names known by this registry.
      SystemCompleter compileCompleters()
      Returns a SystemCompleter that can provide detailed completion information for all registered commands.
      boolean hasCommand​(java.lang.String command)
      Returns whether a command with the specified name is known to this registry.
      java.lang.Object invoke​(CommandRegistry.CommandSession session, java.lang.String command, java.lang.Object... args)
      Execute a command.
      java.lang.String name()
      Returns the name of this registry.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CommandRegistryAdapter

        public CommandRegistryAdapter​(CommandGroup group)
        Creates an adapter wrapping the given command group.
        Parameters:
        group - the new command group to adapt
    • Method Detail

      • name

        public java.lang.String name()
        Description copied from interface: CommandRegistry
        Returns the name of this registry.
        Specified by:
        name in interface CommandRegistry
        Returns:
        the name of the registry
      • commandNames

        public java.util.Set<java.lang.String> commandNames()
        Description copied from interface: CommandRegistry
        Returns the command names known by this registry.
        Specified by:
        commandNames in interface CommandRegistry
        Returns:
        the set of known command names, excluding aliases
      • commandAliases

        public java.util.Map<java.lang.String,​java.lang.String> commandAliases()
        Description copied from interface: CommandRegistry
        Returns a map of alias-to-command names known by this registry.
        Specified by:
        commandAliases in interface CommandRegistry
        Returns:
        a map with alias keys and command name values
      • commandInfo

        public java.util.List<java.lang.String> commandInfo​(java.lang.String command)
        Description copied from interface: CommandRegistry
        Returns a short info about command known by this registry.
        Specified by:
        commandInfo in interface CommandRegistry
        Parameters:
        command - the command name
        Returns:
        a short info about command
      • hasCommand

        public boolean hasCommand​(java.lang.String command)
        Description copied from interface: CommandRegistry
        Returns whether a command with the specified name is known to this registry.
        Specified by:
        hasCommand in interface CommandRegistry
        Parameters:
        command - the command name to test
        Returns:
        true if the specified command is registered
      • compileCompleters

        public SystemCompleter compileCompleters()
        Description copied from interface: CommandRegistry
        Returns a SystemCompleter that can provide detailed completion information for all registered commands.
        Specified by:
        compileCompleters in interface CommandRegistry
        Returns:
        a SystemCompleter that can provide command completion for all registered commands
      • commandDescription

        public CmdDesc commandDescription​(java.util.List<java.lang.String> args)
        Description copied from interface: CommandRegistry
        Returns a command description for use in the JLine Widgets framework. Default method must be overridden to return sub command descriptions.
        Specified by:
        commandDescription in interface CommandRegistry
        Parameters:
        args - command (args[0]) and its arguments
        Returns:
        command description for JLine TailTipWidgets to be displayed in the terminal status bar.
      • invoke

        public java.lang.Object invoke​(CommandRegistry.CommandSession session,
                                       java.lang.String command,
                                       java.lang.Object... args)
                                throws java.lang.Exception
        Description copied from interface: CommandRegistry
        Execute a command.
        Specified by:
        invoke in interface CommandRegistry
        Parameters:
        session - the data of the current command session
        command - the name of the command
        args - arguments of the command
        Returns:
        result of the command execution
        Throws:
        java.lang.Exception - in case of error