1 /*
2 * $Source: /usr/cvsroot/melati/melati/src/main/java/org/melati/template/webmacro/MelatiWebmacroWriter.java,v $
3 * $Revision: 1.9 $
4 *
5 * Copyright (C) 2003 Jim Wright - Bohemian Enterprise
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * Jim Wright <jimw At paneris.org>
42 */
43
44 package org.melati.template.webmacro;
45
46 import org.melati.template.TemplateEngine;
47 import java.io.IOException;
48
49 /**
50 * MelatiWriter that can be used with WebMacro.
51 *
52 * @see WebmacroTemplate#write(org.melati.util.MelatiWriter,
53 * org.melati.template.TemplateContext,
54 * org.melati.template.TemplateEngine)
55 */
56 public interface MelatiWebmacroWriter {
57
58 /**
59 * Return a <code>FastWriter</code> that can be used for a while.
60 *
61 * @see #stopUsingFastWriter(FastWriter)
62 * @param engine the TemplateEngine
63 * @return a FastWriter
64 */
65 FastWriter getFastWriter(TemplateEngine engine);
66
67 /**
68 * Stop using the given <code>FastWriter</code> obtained from
69 * this object.
70 * <p>
71 * Anything written to the given writer since obtained will
72 * have been written to this object on return.
73 *
74 */
75 void stopUsingFastWriter(FastWriter fw) throws IOException;
76
77 }