Package picocli.shell.jline3

Class PicocliCommands

  • All Implemented Interfaces:
    org.jline.console.CommandRegistry
    public class PicocliCommands
extends java.lang.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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PicocliCommands.ClearScreen
      Command that clears the screen.
      static class  PicocliCommands.PicocliCommandsFactory
      Command factory that is necessary for applications that want the use the ClearScreen subcommand.

      • Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry

        org.jline.console.CommandRegistry.CommandSession

    • Constructor Summary

      Constructors 
      Constructor Description
      PicocliCommands​(picocli.CommandLine cmd)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> commandAliases()  
      org.jline.console.CmdDesc commandDescription​(java.lang.String command)  
      org.jline.console.CmdDesc commandDescription​(java.util.List<java.lang.String> args)  
      java.util.List<java.lang.String> commandInfo​(java.lang.String command)  
      java.util.Set<java.lang.String> commandNames()  
      org.jline.reader.impl.completer.SystemCompleter compileCompleters()  
      java.lang.Object execute​(org.jline.console.CommandRegistry.CommandSession session, java.lang.String command, java.lang.String[] args)  
      boolean hasCommand​(java.lang.String command)  
      java.lang.Object invoke​(org.jline.console.CommandRegistry.CommandSession session, java.lang.String command, java.lang.Object... args)  
      java.lang.String name()
      Returns the name shown for this collection of picocli commands in the usage help message.
      void name​(java.lang.String newName)
      Sets the name shown for this collection of picocli commands in the usage help message.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PicocliCommands

        public PicocliCommands​(picocli.CommandLine cmd)

    • Method Detail

      • hasCommand

        public boolean hasCommand​(java.lang.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​(java.util.List<java.lang.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 java.util.List<java.lang.String> commandInfo​(java.lang.String command)
        Specified by:
        commandInfo in interface org.jline.console.CommandRegistry

      • invoke

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

      • execute

        public java.lang.Object execute​(org.jline.console.CommandRegistry.CommandSession session,
                                java.lang.String command,
                                java.lang.String[] args)
                         throws java.lang.Exception
        Throws:
        java.lang.Exception

      • commandNames

        public java.util.Set<java.lang.String> commandNames()
        Specified by:
        commandNames in interface org.jline.console.CommandRegistry

      • commandAliases

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

      • commandDescription

        public org.jline.console.CmdDesc commandDescription​(java.lang.String command)

      • name

        public java.lang.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​(java.lang.String newName)
        Sets the name shown for this collection of picocli commands in the usage help message.
        Parameters:
        newName - the new name to show