Top Methods
jdk.internal.org.jline.reader

public Interface CompletionMatcher

Known Direct Implementers
jdk.internal.org.jline.reader.impl.CompletionMatcherImpl
Imports
java.util.List, .Map

Method Summary

Modifier and TypeMethod and Description
public void
compile(Map<LineReader.Option, Boolean>
LineReader options
options
,
boolean
invoked by complete-prefix or expand-or-complete-prefix widget
prefix
,
CompletingParsedLine
The parsed line within which completion has been requested
line
,
boolean
if completion is case insensitive or not
caseInsensitive
,
int
number of errors accepted in matching
errors
,
String
value of JLineReader variable original-group-name
originalGroupName
)

Compiles completion matcher functions

public Candidate

Returns:

a candidate that have exact match, null if no exact match found
exactMatch
()

public String

Returns:

a common prefix of matched candidates
getCommonPrefix
()

public List<Candidate>

Returns:

a list of candidates that completion matcher matches
matches
(List<Candidate>
list of candidates
candidates
)

Method Detail

compileback to summary
public void compile(Map<LineReader.Option, Boolean> options, boolean prefix, CompletingParsedLine line, boolean caseInsensitive, int errors, String originalGroupName)

Compiles completion matcher functions

Parameters
options:Map<LineReader.Option, Boolean>

LineReader options

prefix:boolean

invoked by complete-prefix or expand-or-complete-prefix widget

line:CompletingParsedLine

The parsed line within which completion has been requested

caseInsensitive:boolean

if completion is case insensitive or not

errors:int

number of errors accepted in matching

originalGroupName:String

value of JLineReader variable original-group-name

exactMatchback to summary
public Candidate exactMatch()
Returns:Candidate

a candidate that have exact match, null if no exact match found

getCommonPrefixback to summary
public String getCommonPrefix()
Returns:String

a common prefix of matched candidates

matchesback to summary
public List<Candidate> matches(List<Candidate> candidates)
Parameters
candidates:List<Candidate>

list of candidates

Returns:List<Candidate>

a list of candidates that completion matcher matches