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 java.lang.Object implements Completer
Completer for a set of strings.- Since:
- 2.3
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Collection<Candidate>
candidates
protected java.util.function.Supplier<java.util.Collection<java.lang.String>>
stringsSupplier
-
Constructor Summary
Constructors Constructor Description StringsCompleter()
StringsCompleter(java.lang.Iterable<java.lang.String> strings)
StringsCompleter(java.lang.String... strings)
StringsCompleter(java.util.Collection<Candidate> candidates)
StringsCompleter(java.util.function.Supplier<java.util.Collection<java.lang.String>> stringsSupplier)
StringsCompleter(Candidate... candidates)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
complete(LineReader reader, ParsedLine commandLine, java.util.List<Candidate> candidates)
Populates candidates with a list of possible completions for the command line.java.lang.String
toString()
-
-
-
Field Detail
-
candidates
protected java.util.Collection<Candidate> candidates
-
stringsSupplier
protected java.util.function.Supplier<java.util.Collection<java.lang.String>> stringsSupplier
-
-
Constructor Detail
-
StringsCompleter
public StringsCompleter()
-
StringsCompleter
public StringsCompleter(java.util.function.Supplier<java.util.Collection<java.lang.String>> stringsSupplier)
-
StringsCompleter
public StringsCompleter(java.lang.String... strings)
-
StringsCompleter
public StringsCompleter(java.lang.Iterable<java.lang.String> strings)
-
StringsCompleter
public StringsCompleter(Candidate... candidates)
-
StringsCompleter
public StringsCompleter(java.util.Collection<Candidate> candidates)
-
-
Method Detail
-
complete
public void complete(LineReader reader, ParsedLine commandLine, 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.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-