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 provides output functionality
24 * and possibly support for user input.
25 */
26 public interface Console
27 {
28
29 //--- Method(s) ---
30
31
32 /***
33 * Returns the {@link Command} object that is associated with
34 * <code>commandName</code>.
35 *
36 * @return null, if the command is not supported; the command, otherwise
37 */
38 Command getCommand(String commandName);
39
40 /***
41 * Returns all supported commands.
42 */
43 Command[] getCommands();
44
45 /***
46 * Returns true, input is echoed on screen.
47 */
48 boolean isEchoing();
49
50 /***
51 * Reads a line from this console. Blocks until a line break is read.
52 */
53 String readln(String prompt);
54
55 /***
56 * Prints <code>text</code> to screen.
57 */
58 void println(String text);
59
60 }