Class PicocliJLineCompleter

java.lang.Object
picocli.shell.jline3.PicocliJLineCompleter
All Implemented Interfaces:
org.jline.reader.Completer
public class PicocliJLineCompleter extends Object implements org.jline.reader.Completer
Implementation of the JLine 3 Completer interface that generates completion candidates for the specified command line based on the CommandLine.Model.CommandSpec that this PicocliJLineCompleter was constructed with.
Since:
3.9

  • Constructor Summary

    Constructors
    Constructor
    Description
    PicocliJLineCompleter(picocli.CommandLine.Model.CommandSpec spec)
    Constructs a new PicocliJLineCompleter for the given command spec.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    complete(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine line, List<org.jline.reader.Candidate> candidates)
    Populates candidates with a list of possible completions for the command line.

    Methods inherited from class Object

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

  • Constructor Details

    • PicocliJLineCompleter

      public PicocliJLineCompleter(picocli.CommandLine.Model.CommandSpec spec)
      Constructs a new PicocliJLineCompleter for the given command spec.
      Parameters:
      spec - the command specification to generate completions for. Must be non-null.

  • Method Details

    • complete

      public void complete(org.jline.reader.LineReader reader, org.jline.reader.ParsedLine line, List<org.jline.reader.Candidate> candidates)
      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 org.jline.reader.Completer
      Parameters:
      reader - The line reader
      line - The parsed command line
      candidates - The List of candidates to populate