Class PicocliCommands

  • All Implemented Interfaces:
    org.jline.console.CommandRegistry

    public class PicocliCommands
    extends Object
    implements org.jline.console.CommandRegistry
    Compiles SystemCompleter for command completion and implements a method commandDescription() that provides command descriptions for JLine TailTipWidgets to be displayed in terminal status bar. SystemCompleter implements the JLine 3 Completer interface. SystemCompleter generates completion candidates for the specified command line based on the CommandLine.Model.CommandSpec that this PicocliCommands was constructed with.
    Since:
    4.1.2
    • Constructor Detail

      • PicocliCommands

        public PicocliCommands​(CommandLine cmd)
    • Method Detail

      • hasCommand

        public boolean hasCommand​(String command)
        Specified by:
        hasCommand in interface org.jline.console.CommandRegistry
        Parameters:
        command -
        Returns:
        true if PicocliCommands contains command
      • compileCompleters

        public org.jline.reader.impl.completer.SystemCompleter compileCompleters()
        Specified by:
        compileCompleters in interface org.jline.console.CommandRegistry
      • commandDescription

        public org.jline.console.CmdDesc commandDescription​(List<String> args)
        Specified by:
        commandDescription in interface org.jline.console.CommandRegistry
        Parameters:
        args -
        Returns:
        command description for JLine TailTipWidgets to be displayed in terminal status bar.
      • commandInfo

        public List<String> commandInfo​(String command)
        Specified by:
        commandInfo in interface org.jline.console.CommandRegistry
      • invoke

        public Object invoke​(org.jline.console.CommandRegistry.CommandSession session,
                             String command,
                             Object... args)
                      throws Exception
        Specified by:
        invoke in interface org.jline.console.CommandRegistry
        Throws:
        Exception
      • commandNames

        public Set<String> commandNames()
        Specified by:
        commandNames in interface org.jline.console.CommandRegistry
      • commandAliases

        public Map<String,​String> commandAliases()
        Specified by:
        commandAliases in interface org.jline.console.CommandRegistry
      • commandDescription

        public org.jline.console.CmdDesc commandDescription​(String command)
      • name

        public String name()
        Returns the name shown for this collection of picocli commands in the usage help message. If not set with name(String), this returns CommandRegistry.name().
        Specified by:
        name in interface org.jline.console.CommandRegistry
        Returns:
        the name shown for this collection of picocli commands in the usage help message
      • name

        public void name​(String newName)
        Sets the name shown for this collection of picocli commands in the usage help message.
        Parameters:
        newName - the new name to show