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 10:15:32 -0500 (dom, 06 mar 2011) $:
26 * Revision: $LastChangedRevision: 1913 $:
27 * URL: $HeadURL: https://zemucan.svn.sourceforge.net/svnroot/zemucan/branches/zemucan_v1/source-code/uiApi/src/main/java/name/angoca/zemucan/ui/api/AbstractInterfaceController.java $:
28 */
29 package name.angoca.zemucan.ui.api;
30
31 import name.angoca.zemucan.AbstractZemucanException;
32
33 /**
34 * This is the interface controller that manages the reads and the printer.
35 * <p>
36 * <b>Control Version</b>
37 * <p>
38 * <ul>
39 * <li>0.0.1 Class creation.</li>
40 * <li>0.1.0 Class renamed.</li>
41 * <li>0.2.0 No constructor.</li>
42 * <li>1.0.0 Moved to version 1.</li>
43 * <li>1.1.0 Load synchronization.</li>
44 * <li>1.2.0 Synchronized version with implementation.</li>
45 * <li>1.2.1 Constants.</li>
46 * </ul>
47 *
48 * @author Andres Gomez Casanova <a
49 * href="mailto:a n g o c a at y a h o o dot c o m">(AngocA)</a>
50 * @version 1.2.1 2010-06-01
51 * @since 1.0
52 */
53 public abstract class AbstractInterfaceController {
54
55 /**
56 * Property to show the introductory help.
57 */
58 protected static final String SHOW_INTRO_PROPERTY = "ShowIntro"; //$NON-NLS-1$
59 /**
60 * Property to show the application's license.
61 */
62 protected static final String SHOW_LICENSE = "ShowLicense";
63
64 /**
65 * Starts to read commands from the user and process them.
66 *
67 * @param synchro
68 * Object for synchronization between console reader and grammar
69 * constructor. If the object is null, that means there is not a
70 * synchronization.
71 * @param synchronizedLoad
72 * Object that helps the synchronization. This is null when there
73 * is not synchronization.
74 * @throws AbstractZemucanException
75 * When there is a IO problem.
76 */
77 public abstract void start(final Thread/* ? */synchro,
78 final SynchronizedLoad/* ? */synchronizedLoad)
79 throws AbstractZemucanException;
80 }