org.jline.reader

Interface Completer

All Known Implementing Classes:

AggregateCompleter, ArgumentCompleter, EnumCompleter, FileNameCompleter, NullCompleter, StringsCompleter

public interface Completer

A completer is the mechanism by which tab-completion candidates will be resolved.

Since:

2.3

Author:

Marc Prud'hommeaux, Jason Dillon, Guillaume Nodet

Method Summary

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

Method Detail

complete

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 - The line reader

line - The parsed command line

candidates - The List of candidates to populate