org.xnap.cmdl
Interface Completer

All Known Implementing Classes:

DefaultCompleter

public interface Completer

Defines the requirements for classes that provide a completer.

Method Summary

java.lang.String

completer(java.lang.String text, int state) Returns a possible completion for text.

Method Detail

completer

java.lang.String completer(java.lang.String text,
                           int state)

Returns a possible completion for text.

Parameters:

text - the start of the word to be completed

state - 0 or positive int. This state is zero on the first call for a completion request and increments for each subsequent call until the end of choices is reached.

Returns:

String with a completion choice or null, if there are no more choices.

See Also:

ReadlineCompleter