View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/melati/src/main/java/org/melati/template/webmacro/MelatiFastWriter.java,v $
3    * $Revision: 1.17 $
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  
49  import javax.servlet.http.HttpServletResponse;
50  
51  import org.melati.template.TemplateEngine;
52  import org.melati.util.MelatiWriter;
53  import org.webmacro.Broker;
54  
55  /**
56   * Writes to an output object.
57   */
58  
59  public class MelatiFastWriter extends MelatiWriter
60      implements MelatiWebmacroWriter {
61  
62    protected OutputStream outputStream;
63    
64    /**
65     * Constructor.
66     */
67    public MelatiFastWriter(Broker broker, HttpServletResponse response) 
68        throws IOException {
69      this(broker, response.getOutputStream(), response.getCharacterEncoding());
70    }
71  /*  
72    public MelatiFastWriter(HttpServletResponse response) 
73        throws IOException {
74      this(response.getOutputStream(), response.getCharacterEncoding());
75    }
76  */  
77    /**
78     * Constructor.
79     */
80    public MelatiFastWriter(Broker broker, OutputStream output, String encoding)
81        throws IOException {
82      // need to make this accessable to subclasses
83      outputStream = output;
84      out = FastWriter.getInstance(broker, output, encoding);
85    }
86  /*  
87    public MelatiFastWriter(OutputStream output, String encoding)
88        throws IOException {
89      // need to make this accessable to subcalsses
90      outputStream = output;
91      out = FastWriter.getInstance(output, encoding);
92    }
93  */
94    /**
95     * @return the peer
96     */
97    public FastWriter getPeer() {
98      // as we can write to the underlying peer, the Flusher may not get started
99      // so we should start it here
100     startFlushing();
101     return (FastWriter)out;
102   }
103 
104   /**
105    * Return a <code>FastWriter</code> that can be used for a while instead.
106    *
107    * @see #stopUsingFastWriter(FastWriter)
108    */
109   public FastWriter getFastWriter(TemplateEngine engine) {
110     return getPeer();
111   }
112 
113   /**
114    * Returns the underlying <code>OutputStream</code> that can be used.
115    *
116    * @see #stopUsingFastWriter(FastWriter)
117    */
118   public OutputStream getOutputStream() {
119     return outputStream;
120   }
121 
122   /**
123    * Stop using the given <code>FastWriter</code> obtained from
124    * this object.
125    *
126    * @see #getFastWriter(TemplateEngine)
127    */
128   public void stopUsingFastWriter(FastWriter fw) throws IOException {
129     // Do nothing
130   }
131 
132 
133 }