Package org.jline.reader.impl.completer

Class StringsCompleter

java.lang.Object

org.jline.reader.impl.completer.StringsCompleter

All Implemented Interfaces:

Completer

Direct Known Subclasses:

EnumCompleter

public class StringsCompleter
extends Object
implements Completer

Completer for a set of strings.

Since:

2.3

Author:

Jason Dillon

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<Candidate>	candidates
protected Supplier<Collection<String>>	stringsSupplier

Constructor Summary

Constructors

Constructor	Description
StringsCompleter()
StringsCompleter(Iterable<String> strings)
StringsCompleter(String... strings)
StringsCompleter(Collection<Candidate> candidates)
StringsCompleter(Supplier<Collection<String>> stringsSupplier)
StringsCompleter(Candidate... candidates)

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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

candidates

protected Collection<Candidate> candidates

stringsSupplier

protected Supplier<Collection<String>> stringsSupplier

Constructor Details

StringsCompleter

public StringsCompleter()

StringsCompleter

public StringsCompleter(Supplier<Collection<String>> stringsSupplier)

StringsCompleter

public StringsCompleter(String... strings)

StringsCompleter

public StringsCompleter(Iterable<String> strings)

StringsCompleter

public StringsCompleter(Candidate... candidates)

StringsCompleter

public StringsCompleter(Collection<Candidate> candidates)

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.

Specified by:

complete in interface Completer

Parameters:

reader - The line reader

commandLine - The parsed command line

candidates - The List of candidates to populate

toString

public String toString()

Overrides:

toString in class Object