Package jline
Interface Completor
-
- All Known Implementing Classes:
ArgumentCompletor
,ClassNameCompletor
,FileNameCompletor
,MultiCompletor
,NullCompletor
,SimpleCompletor
public interface Completor
A Completor is the mechanism by which tab-completion candidates will be resolved.- Author:
- Marc Prud'hommeaux
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
complete(java.lang.String buffer, int cursor, java.util.List candidates)
Populates candidates with a list of possible completions for the buffer.
-
-
-
Method Detail
-
complete
int complete(java.lang.String buffer, int cursor, java.util.List candidates)
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 theList
before returning.- Parameters:
buffer
- the buffercandidates
- theList
of candidates to populate- Returns:
- the index of the buffer for which the completion will be relative
-
-