APIdia Launch Partner
Top Description Methods
jdk.internal.org.jline.reader

public Interface Completer

Known Direct Implementers
jdk.internal.org.jline.reader.impl.completer.AggregateCompleter, jdk.internal.org.jline.reader.impl.completer.ArgumentCompleter, jdk.internal.org.jline.reader.impl.completer.FileNameCompleter, jdk.internal.org.jline.reader.impl.completer.NullCompleter, jdk.internal.org.jline.reader.impl.completer.StringsCompleter, jdk.internal.org.jline.reader.impl.completer.SystemCompleter
Imports
java.util.List

A completer is the mechanism by which tab-completion candidates will be resolved.
Authors
Marc Prud'hommeaux, Jason Dillon, Guillaume Nodet
Since
2.3

Method Summary

Modifier and TypeMethod and Description
public void
complete(LineReader
The line reader
reader
,
ParsedLine
The parsed command line
line
,
List<Candidate>
The List of candidates to populate
candidates
)

Populates candidates with a list of possible completions for the command line.

Method Detail

completeback to summary
public void complete(LineReader reader, ParsedLine line, List<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.

Parameters
reader:LineReader

The line reader

line:ParsedLine

The parsed command line

candidates:List<Candidate>

The List of candidates to populate