Package org.jline.builtins

Class Completers.TreeCompleter

java.lang.Object

org.jline.builtins.Completers.TreeCompleter

All Implemented Interfaces:

Completer

Enclosing class:

Completers

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Completers.TreeCompleter.Node

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Completers.RegexCompleter	completer
(package private) java.util.Map<java.lang.String,Completer>	completers

Constructor Summary

Constructors

Constructor	Description
TreeCompleter(java.util.List<Completers.TreeCompleter.Node> nodes)
TreeCompleter(Completers.TreeCompleter.Node... nodes)

Method Summary

Modifier and Type	Method	Description
(package private) void	addRoots(java.lang.StringBuilder sb, java.util.List<Completers.TreeCompleter.Node> nodes)
void	complete(LineReader reader, ParsedLine line, java.util.List<Candidate> candidates)	Populates candidates with a list of possible completions for the command line.
static Completers.TreeCompleter.Node	node(java.lang.Object... objs)

Methods inherited from class java.lang.Object

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

Field Detail

completers

final java.util.Map<java.lang.String,Completer> completers

completer

final Completers.RegexCompleter completer

Constructor Detail

TreeCompleter

public TreeCompleter(Completers.TreeCompleter.Node... nodes)

TreeCompleter

public TreeCompleter(java.util.List<Completers.TreeCompleter.Node> nodes)

Method Detail

node

public static Completers.TreeCompleter.Node node(java.lang.Object... objs)

addRoots

void addRoots(java.lang.StringBuilder sb,
              java.util.List<Completers.TreeCompleter.Node> nodes)

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