1 /*
2 * db2sa: DB2 Syntax Assistant
3 * Copyright (C) Andres Gomez Casanova
4 *
5 * This file is part of db2sa.
6 *
7 * db2sa 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 * db2sa 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: 2009-04-13 15:00:52 +0200 (Mon, 13 Apr 2009) $:
26 * Revision: $LastChangedRevision: 58 $:
27 * URL: $HeadURL: https://db2sa.svn.sourceforge.net/svnroot/db2sa/branches/db2sa_beta/source-code/src/main/java/name/angoca/db2sa/cli/InputReader.java $:
28 */
29 package name.angoca.db2sa.cli;
30
31 import name.angoca.db2sa.cli.exceptions.InputReaderException;
32
33 /**
34 * Interface that defines the structure of a reader.<br/>
35 * <b>Control Version</b><br />
36 * <ul>
37 * <li>0.0.1 Class creation.</li>
38 * <li>1.0.0 Moved to version 1.</li>
39 * </ul>
40 *
41 * @author Andres Gomez Casanova <a
42 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
43 * @version 1.0.0 2009-07-19
44 */
45 public interface InputReader {
46 /**
47 * Reads the phrases written by the user.
48 *
49 * @return Phrase written by the user.
50 * @throws InputReaderException
51 * If some problem occurs.
52 */
53 String/* ! */readString() throws InputReaderException;
54 }