Package org.jline.reader
Interface CompletionMatcher
- All Known Implementing Classes:
CompletionMatcherImpl
public interface CompletionMatcher
-
Method Summary
Modifier and TypeMethodDescriptionvoid
compile
(Map<LineReader.Option, Boolean> options, boolean prefix, CompletingParsedLine line, boolean caseInsensitive, int errors, String originalGroupName) Compiles completion matcher functions
-
Method Details
-
compile
void compile(Map<LineReader.Option, Boolean> options, boolean prefix, CompletingParsedLine line, boolean caseInsensitive, int errors, String originalGroupName) Compiles completion matcher functions- Parameters:
options
- LineReader optionsprefix
- invoked by complete-prefix or expand-or-complete-prefix widgetline
- The parsed line within which completion has been requestedcaseInsensitive
- if completion is case insensitive or noterrors
- number of errors accepted in matchingoriginalGroupName
- value of JLineReader variable original-group-name
-
matches
- Parameters:
candidates
- list of candidates- Returns:
- a list of candidates that completion matcher matches
-
exactMatch
Candidate exactMatch()- Returns:
- a candidate that have exact match, null if no exact match found
-
getCommonPrefix
String getCommonPrefix()- Returns:
- a common prefix of matched candidates
-