Package org.jline.console.impl

Class SystemRegistryImpl.PipelineCompleter

java.lang.Object

org.jline.console.impl.SystemRegistryImpl.PipelineCompleter

All Implemented Interfaces:

Completer

Enclosing class:

SystemRegistryImpl

private static class SystemRegistryImpl.PipelineCompleter
extends Object
implements Completer

Field Summary

Fields

Modifier and Type	Field	Description
private final SystemRegistryImpl.NamesAndValues	names
private final Map<SystemRegistryImpl.Pipe,String>	pipeName
private final Supplier<Path>	workDir

Constructor Summary

Constructors

Constructor	Description
PipelineCompleter(Supplier<Path> workDir, Map<SystemRegistryImpl.Pipe,String> pipeName, SystemRegistryImpl.NamesAndValues names)

Method Summary

Modifier and Type	Method	Description
void	complete(LineReader reader, ParsedLine commandLine, List<Candidate> candidates)	Populates candidates with a list of possible completions for the command line.
private void	doCandidates(List<Candidate> candidates, Collection<String> fields, String curBuf, String postFix, String hint)
Completer	doCompleter()

Methods inherited from class java.lang.Object

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

Field Details

names

private final SystemRegistryImpl.NamesAndValues names

workDir

private final Supplier<Path> workDir

pipeName

private final Map<SystemRegistryImpl.Pipe,String> pipeName

Constructor Details

PipelineCompleter

public PipelineCompleter(Supplier<Path> workDir,
 Map<SystemRegistryImpl.Pipe,String> pipeName,
 SystemRegistryImpl.NamesAndValues names)

Method Details

doCompleter

public Completer doCompleter()

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:

• Candidate

doCandidates

private void doCandidates(List<Candidate> candidates,
 Collection<String> fields,
 String curBuf,
 String postFix,
 String hint)