jline

Interface Completor

All Known Subinterfaces:

Command

All Known Implementing Classes:

AbstractCommand, AbstractFileCommand, AbstractUUIDCommand, Alias, ArgumentCompletor, Bsh, Cat, Catch, Cd, ClassNameCompletor, Clear, CommandArgsCompletor, CommandCompletor, Connections, Cp, Date, Disks, Echo, Edit, Env, Exit, FileNameCompletor, Follow, Help, Kill, Ls, Mem, Mkdir, Msh, MultiCompletor, Mv, NullCompletor, Pref, Ps, Pwd, Refresh, Rm, RootShell, Run, Scp, ShellCommand, ShowLastError, Shutdown, SimpleCompletor, Sleep, Source, Term, Threads, Unalias, VirtualShellCompletor, Who

public interface Completor

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

Author:

Marc Prud'hommeaux

Method Summary

Modifier and Type	Method and Description
int	complete(String buffer, int cursor, List<String> candidates) Populates candidates with a list of possible completions for the buffer.

Method Detail

complete

int complete(String buffer,
             int cursor,
             List<String> 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

candidates - the List of candidates to populate

Returns:

the index of the buffer for which the completion will be relative