public interface

Completer

jline.console.completer.Completer
Known Indirect Subclasses

Class Overview

A completer is the mechanism by which tab-completion candidates will be resolved.

Summary

Public Methods
abstract int complete(String buffer, int cursor, List<CharSequence> candidates)
Populates candidates with a list of possible completions for the buffer.

Public Methods

public abstract int complete (String buffer, int cursor, List<CharSequence> 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 the List before returning.

Parameters
buffer The buffer
cursor The current position of the cursor in the buffer
candidates The List of candidates to populate
Returns
  • The index of the buffer for which the completion will be relative