Class SystemCompleter

  • All Implemented Interfaces:
    Completer

    public class SystemCompleter
    extends java.lang.Object
    implements Completer
    Completer which contains multiple completers and aggregates them together.
    • Constructor Summary

      Constructors 
      Constructor Description
      SystemCompleter()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(java.lang.String command, java.util.List<Completer> completers)  
      void add​(java.lang.String command, Completer completer)  
      void add​(java.util.List<java.lang.String> commands, Completer completer)  
      void add​(SystemCompleter other)  
      void addAliases​(java.util.Map<java.lang.String,​java.lang.String> aliasCommand)  
      void compile()  
      void compile​(java.util.function.Function<java.lang.String,​Candidate> candidateBuilder)  
      void complete​(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
      Populates candidates with a list of possible completions for the command line.
      java.util.Map<java.lang.String,​java.util.List<Completer>> getCompleters()  
      boolean isCompiled()  
      • Methods inherited from class java.lang.Object

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

      • SystemCompleter

        public SystemCompleter()
    • Method Detail

      • complete

        public void complete​(LineReader reader,
                             ParsedLine commandLine,
                             java.util.List<Candidate> candidates)
        Description copied from interface: Completer
        Populates candidates with a list of possible completions for the command line.

        The list of candidates will be sorted and filtered by the LineReader, so that the list of candidates displayed to the user will usually be smaller than the list given by the completer. Thus it is not necessary for the completer to do any matching based on the current buffer. On the contrary, in order for the typo matcher to work, all possible candidates for the word being completed should be returned.

        Implementations should add Candidate objects to the candidates list. Each candidate can include additional information such as descriptions, groups, and display attributes that will be used when presenting completion options to the user.

        This method is called by the LineReader when the user requests completion, typically by pressing the Tab key.

        Specified by:
        complete in interface Completer
        Parameters:
        reader - The line reader instance that is requesting completion
        commandLine - The parsed command line containing the current input state
        candidates - The List of candidates to populate with completion options
        See Also:
        Candidate
      • isCompiled

        public boolean isCompiled()
      • add

        public void add​(java.lang.String command,
                        java.util.List<Completer> completers)
      • add

        public void add​(java.util.List<java.lang.String> commands,
                        Completer completer)
      • add

        public void add​(java.lang.String command,
                        Completer completer)
      • addAliases

        public void addAliases​(java.util.Map<java.lang.String,​java.lang.String> aliasCommand)
      • compile

        public void compile()
      • compile

        public void compile​(java.util.function.Function<java.lang.String,​Candidate> candidateBuilder)
      • getCompleters

        public java.util.Map<java.lang.String,​java.util.List<Completer>> getCompleters()