View Javadoc
1   /*
2    * $Source$
3    * $Revision$
4    *
5    * Copyright (C) 2000 Tim Joyce
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   *     Tim Joyce <timj@paneris.org>
42   */
43  
44  package org.melati.template.webmacro;
45  
46  import java.io.IOException;
47  import java.io.OutputStream;
48  import java.io.UnsupportedEncodingException;
49  
50  import javax.servlet.http.HttpServletResponse;
51  
52  import org.melati.template.TemplateEngine;
53  import org.melati.template.TemplateIOException;
54  import org.melati.util.MelatiWriter;
55  import org.webmacro.Broker;
56  
57  /**
58   * Writes to an output object.
59   */
60  
61  public class MelatiFastWriter extends MelatiWriter
62      implements MelatiWebmacroWriter {
63  
64    protected OutputStream outputStream;
65    
66    /**
67     * Constructor.
68     */
69    public MelatiFastWriter(Broker broker, HttpServletResponse response) 
70        throws IOException {
71      this(broker, response.getOutputStream(), response.getCharacterEncoding());
72    }
73    /**
74     * Constructor.
75     */
76    public MelatiFastWriter(Broker broker, OutputStream output, String encoding) {
77      // need to make this accessible to subclasses
78      outputStream = output;
79      try {
80        out = org.webmacro.FastWriter.getInstance(broker, output, encoding);
81      } catch (UnsupportedEncodingException e) {
82        throw new TemplateIOException(e);
83      }
84    }
85    
86    /**
87     * Return a <code>FastWriter</code> that can be used for a while instead.
88     *
89     * @see #stopUsingFastWriter
90     */
91    public org.webmacro.FastWriter getFastWriter() {
92      // as we can write to the underlying peer, the Flusher may not get started
93      // so we should start it here
94      startFlushing();
95      return (org.webmacro.FastWriter)out;
96    }
97  
98  
99    /**
100    * Stop using the given <code>FastWriter</code> obtained from
101    * this object.
102    *
103    * @see #getFastWriter
104    */
105   public void stopUsingFastWriter(org.webmacro.FastWriter fw) {
106     // Do nothing
107   }
108 
109 
110 }