KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > mckoi > util > UserTerminal


1 /**
2  * com.mckoi.util.UserTerminal 12 Apr 2001
3  *
4  * Mckoi SQL Database ( http://www.mckoi.com/database )
5  * Copyright (C) 2000, 2001, 2002 Diehl and Associates, Inc.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * Version 2 as published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License Version 2 for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * Version 2 along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  *
20  * Change Log:
21  *
22  *
23  */
24
25 package com.mckoi.util;
26
27 /**
28  * An interface that represents a terminal that is asked questions in human
29  * and machine understandable terms, and sends answers. This interface is
30  * intended for an interface in which the user is asked questions, or for an
31  * automated tool.
32  *
33  * @author Tobias Downer
34  */
35
36 public interface UserTerminal {
37
38   /**
39    * Outputs a string of information to the terminal.
40    */
41   public void print(String JavaDoc str);
42
43   /**
44    * Outputs a string of information and a newline to the terminal.
45    */
46   public void println(String JavaDoc str);
47
48   /**
49    * Asks the user a question from the 'question' string. The 'options' list
50    * is the list of options that the user may select from. The
51    * 'default_answer' is the option that is selected by default.
52    */
53   public int ask(String JavaDoc question, String JavaDoc[] options, int default_answer);
54
55 }
56
Popular Tags