Class StringsCompleter

java.lang.Object
org.jline.reader.impl.completer.StringsCompleter
All Implemented Interfaces:
Completer
Direct Known Subclasses:
EnumCompleter

public class StringsCompleter extends Object implements Completer
Completer for a set of strings.
Since:
2.3
  • Field Details

  • Constructor Details

    • StringsCompleter

      public StringsCompleter()
    • StringsCompleter

      public StringsCompleter(Supplier<Collection<String>> stringsSupplier)
    • StringsCompleter

      public StringsCompleter(String... strings)
    • StringsCompleter

      public StringsCompleter(Iterable<String> strings)
    • StringsCompleter

      public StringsCompleter(Candidate... candidates)
    • StringsCompleter

      public StringsCompleter(Collection<Candidate> candidates)
  • Method Details

    • complete

      public void complete(LineReader reader, ParsedLine commandLine, 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:
    • toString

      public String toString()
      Overrides:
      toString in class Object