View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/melati/src/main/java/org/melati/template/velocity/MelatiBufferedVelocityWriter.java,v $
3    * $Revision: 1.9 $
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 At paneris.org>
42   */
43  
44  package org.melati.template.velocity;
45  
46  import java.io.ByteArrayOutputStream;
47  import java.io.IOException;
48  import java.io.OutputStream;
49  
50  import javax.servlet.http.HttpServletResponse;
51  
52  /**
53   * Provides an interface for objects that output from melati.
54   */
55  
56  public class MelatiBufferedVelocityWriter extends MelatiVelocityWriter {
57  
58    private OutputStream underlying;
59    private ByteArrayOutputStream buffer;
60  
61    /**
62     * Constructor.
63     * @param output OutputStream to write to
64     * @param encoding character encoding to use 
65     */
66    public MelatiBufferedVelocityWriter(OutputStream output, String encoding)
67        throws IOException {
68      super(new ByteArrayOutputStream(), encoding);
69      buffer = (ByteArrayOutputStream)outputStream;
70      underlying = output;
71    }
72  
73    /**
74     * Constructor.
75     * @param response from which to get OutputSteram and encoding
76     * @throws IOException
77     */
78    public MelatiBufferedVelocityWriter(HttpServletResponse response) 
79        throws IOException {
80      this(response.getOutputStream(), response.getCharacterEncoding());
81    }
82    
83  
84    /**
85     * {@inheritDoc}
86     * @see org.melati.template.velocity.MelatiVelocityWriter#close()
87     */
88    public void close() throws IOException {
89      super.close();
90      try { 
91        buffer.writeTo(underlying);
92      } catch (IOException e) { 
93        e = null;
94      }
95      buffer.close(); 
96      underlying.flush();
97      underlying.close();
98    }
99    
100   /**
101    * {@inheritDoc}
102    * @see org.melati.util.MelatiWriter#flush()
103    */
104   public void flush() throws IOException {
105     out.flush();
106     buffer.writeTo(underlying);
107     buffer.reset(); 
108     underlying.flush();
109   }  
110 
111   /**
112    * {@inheritDoc}
113    * @see org.melati.util.MelatiWriter#reset()
114    */
115   public void reset() throws IOException {
116     out.flush();
117     buffer.reset();
118   }
119 
120 }