View Javadoc

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/OutputWriter.java $:
28   */
29  package name.angoca.zemucan.ui.api;
30  
31  /**
32   * Interface that defines the structure of a writer or also called screen
33   * printer.
34   * <p>
35   * <b>Control Version</b>
36   * <p>
37   * <ul>
38   * <li>0.0.1 Class creation.</li>
39   * <li>1.0.0 Moved to version 1.</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.0.0 2009-07-19
45   * @since 1.0
46   */
47  public interface OutputWriter {
48  
49      /**
50       * Writes a set of strings with a carriage return at the end of it.
51       *
52       * @param string
53       *            String to write.
54       * @throws OutputWriterException
55       *             If there is a problem when writing.
56       */
57      void writeLine(final String/* ! */string) throws OutputWriterException;
58  
59      /**
60       * Writes a set of strings without a carriage return.
61       *
62       * @param string
63       *            String to write in the screen.
64       * @throws OutputWriterException
65       *             If there is a problem when writing.
66       */
67      void writeString(final String/* ! */string) throws OutputWriterException;
68  }