Package org.jline.builtins

Class Completers.Completer

java.lang.Object

org.jline.builtins.Completers.Completer

All Implemented Interfaces:

Completer

Enclosing class:

Completers

public static class Completers.Completer
extends java.lang.Object
implements Completer

Field Summary

Fields

Modifier and Type	Field	Description
private Completers.CompletionEnvironment	environment

Constructor Summary

Constructors

Constructor	Description
Completer(Completers.CompletionEnvironment environment)

Method Summary

Modifier and Type	Method	Description
void	complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Populates candidates with a list of possible completions for the command line.
protected void	completeCommand(java.util.List<Candidate> candidates)
protected void	completeCommandArguments(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates, java.util.List<Completers.CompletionData> completions)
private boolean	isTrue(java.lang.Object result)
protected void	tryCompleteArguments(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)

Methods inherited from class java.lang.Object

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

Field Detail

environment

private final Completers.CompletionEnvironment environment

Constructor Detail

Completer

public Completer(Completers.CompletionEnvironment environment)

Method Detail

complete

public void complete(LineReader reader,
                     ParsedLine line,
                     java.util.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.

Specified by:

complete in interface Completer

Parameters:

reader - The line reader

line - The parsed command line

candidates - The List of candidates to populate

tryCompleteArguments

protected void tryCompleteArguments(LineReader reader,
                                    ParsedLine line,
                                    java.util.List<Candidate> candidates)

completeCommandArguments

protected void completeCommandArguments(LineReader reader,
                                        ParsedLine line,
                                        java.util.List<Candidate> candidates,
                                        java.util.List<Completers.CompletionData> completions)

completeCommand

protected void completeCommand(java.util.List<Candidate> candidates)

isTrue

private boolean isTrue(java.lang.Object result)