Package org.jline.console.impl

Class ConsoleEngineImpl.VariableReferenceCompleter

java.lang.Object

org.jline.console.impl.ConsoleEngineImpl.VariableReferenceCompleter

All Implemented Interfaces:

Completer

Enclosing class:

ConsoleEngineImpl

protected static class ConsoleEngineImpl.VariableReferenceCompleter
extends Object
implements Completer

Constructor Summary

Constructors

Constructor	Description
VariableReferenceCompleter(ScriptEngine engine)

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.

Methods inherited from class java.lang.Object

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

Constructor Details

VariableReferenceCompleter

public VariableReferenceCompleter(ScriptEngine engine)

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:

• Candidate