View Javadoc

1   /*
2    * $Source: /usr/cvsroot/melati/melati/src/main/java/org/melati/template/webmacro/MelatiWebmacroStringWriter.java,v $
3    * $Revision: 1.12 $
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.Melati;
47  import org.melati.template.TemplateEngine;
48  import org.melati.util.MelatiBugMelatiException;
49  import org.melati.util.MelatiStringWriter;
50  
51  import org.webmacro.WM;
52  
53  import java.io.IOException;
54  import java.io.UnsupportedEncodingException;
55  
56  /**
57   * {@link MelatiStringWriter} that can be used with WebMacro.
58   *
59   * @see WebmacroTemplate#write(org.melati.util.MelatiWriter, 
60   *                             org.melati.template.TemplateContext, 
61   *                             org.melati.template.TemplateEngine)
62   */
63  public class MelatiWebmacroStringWriter extends MelatiStringWriter
64      implements MelatiWebmacroWriter {
65  
66    /**
67     * @return a <code>FastWriter</code> that can be used for a while.
68     *
69     * {@inheritDoc}
70     * @see #stopUsingFastWriter(FastWriter)
71     * @see org.melati.template.webmacro.MelatiWebmacroWriter#getFastWriter
72     *         (org.melati.template.TemplateEngine)
73     */
74    public FastWriter getFastWriter(TemplateEngine engine) {
75      WebmacroServletTemplateEngine wte = (WebmacroServletTemplateEngine)engine;
76      WM wm = (WM)wte.getEngine();
77      // All we want to do is efficiently convert to and from bytes
78      // in an encoding that works for all Java characters.
79      // Sun's Javadocs java.nio.charset.Charset explains this well
80      // where other references fail to spell it out: UTF-16 is cool.
81      // Except Webmacro does not support it due to byte order mark.
82      // So Jim used UTF-16BE
83      // Changed to default in the desperate hope of getting something to work
84      try {
85        return FastWriter.getInstance(wm.getBroker(), Melati.DEFAULT_ENCODING);
86      }
87      catch (UnsupportedEncodingException e) {
88        throw new MelatiBugMelatiException(
89                "Assumption that all JVMs and WebMacro support " + Melati.DEFAULT_ENCODING + " has not held", e);
90      }
91    }
92  
93    /**
94     * Stop using the given <code>FastWriter</code> obtained from
95     * this object.
96     */
97    public void stopUsingFastWriter(FastWriter fw) throws IOException {
98      write(fw.toString());
99      fw.close();
100   }
101 
102 }