Class ConsoleEngineImpl.AliasValueCompleter

  • All Implemented Interfaces:
    Completer
    Enclosing class:
    ConsoleEngineImpl

    private static class ConsoleEngineImpl.AliasValueCompleter
    extends java.lang.Object
    implements Completer
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Map<java.lang.String,​java.lang.String> aliases  
    • Constructor Summary

      Constructors 
      Constructor Description
      AliasValueCompleter​(java.util.Map<java.lang.String,​java.lang.String> aliases)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void complete​(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
      Populates candidates with a list of possible completions for the command line.
      • Methods inherited from class java.lang.Object

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

      • aliases

        private final java.util.Map<java.lang.String,​java.lang.String> aliases
    • Constructor Detail

      • AliasValueCompleter

        public AliasValueCompleter​(java.util.Map<java.lang.String,​java.lang.String> aliases)
    • 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.
        Specified by:
        complete in interface Completer
        Parameters:
        reader - The line reader
        commandLine - The parsed command line
        candidates - The List of candidates to populate