1 /*
2 * XNap - A P2P framework and client.
3 *
4 * See the file AUTHORS for copyright information.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
20 package org.xnap.cmdl;
21
22 /***
23 * Defines the requirements for classes that provide a completer.
24 */
25 public interface Completer
26 {
27
28 //--- Method(s) ---
29
30 /***
31 * Returns a possible completion for <code>text</code>.
32 *
33 * @param text the start of the word to be completed
34 * @param state 0 or positive int. This state is zero on the first call
35 * for a completion request and increments for each
36 * subsequent call until the end of choices is reached.
37 *
38 * @return String with a completion choice or <code>null</code>, if there
39 * are no more choices.
40 *
41 * @see org.gnu.readline.ReadlineCompleter
42 */
43 String completer(String text, int state);
44
45 }