1 /*
2 * Zemucan: A Syntax Assistant for DB2
3 * Copyright (C) 2009, 2010 Andres Gomez Casanova
4 *
5 * This file is part of Zemucan.
6 *
7 * Zemucan is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * Zemucan is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Contact:
21 * a n g o c a at y a h o o dot c o m
22 * Cra. 45 No 61 - 31, Bogota, Colombia.
23 *
24 * Author: $LastChangedBy: angoca $:
25 * Date: $LastChangedDate: 2011-03-06 09:19:05 -0500 (dom, 06 mar 2011) $:
26 * Revision: $LastChangedRevision: 1910 $:
27 * URL: $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/uiApi/src/main/java/name/angoca/zemucan/ui/api/InputReader.java $:
28 */
29 package name.angoca.zemucan.ui.api;
30
31 /**
32 * Interface that defines the structure of a reader.
33 * <p>
34 * <b>Control Version</b>
35 * <p>
36 * <ul>
37 * <li>0.0.1 Class creation.</li>
38 * <li>1.0.0 Moved to version 1.</li>
39 * <li>1.1.0 Exception hierarchy changed.</li>
40 * </ul>
41 *
42 * @author Andres Gomez Casanova <a
43 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
44 * @version 1.1.0 2009-08-16
45 * @since 1.0
46 */
47 public interface InputReader {
48 /**
49 * Exit error code caused from assisting.
50 */
51 int ASSISTING_ERROR = -2;
52
53 /**
54 * Reads the phrases written by the user.
55 *
56 * @return Phrase written by the user.
57 * @throws AbstractUIException
58 * If some problem occurs with the user interaction.
59 */
60 String/* ! */readString() throws AbstractUIException;
61 }