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 and Description
protected Collection<Candidate>	candidates

Constructor Summary

Constructors

Constructor and Description
StringsCompleter()
StringsCompleter(Iterable<String> strings)
StringsCompleter(String... strings)

Method Summary

Modifier and Type	Method and Description
void	complete(LineReader reader, ParsedLine commandLine, List<Candidate> candidates) Populates candidates with a list of possible completions for the buffer.

Methods inherited from class java.lang.Object

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

Field Detail

candidates

protected final Collection<Candidate> candidates

Constructor Detail

StringsCompleter

public StringsCompleter()

StringsCompleter

public StringsCompleter(String... strings)

StringsCompleter

public StringsCompleter(Iterable<String> strings)

Method Detail

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 buffer. The candidates list will not be sorted before being displayed to the user: thus, the complete method should sort the List before returning.

Specified by:

complete in interface Completer

commandLine - The parsed command line

candidates - The List of candidates to populate