KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > template > utility > NormalizeNewlines


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */
52
53 package freemarker.template.utility;
54
55 import freemarker.template.TemplateTransformModel;
56 import java.io.*;
57 import java.util.Map JavaDoc;
58
59 /**
60  * <p>Transformer that supports FreeMarker legacy behavior: all newlines appearing
61  * within the transformed area will be transformed into the platform's default
62  * newline. Unlike the old behavior, however, newlines generated by the data
63  * model are also converted. Legacy behavior was to leave newlines in the
64  * data model unaltered.</p>
65  *
66  * <p>Usage:<br />
67  * From java:</p>
68  * <pre>
69  * SimpleHash root = new SimpleHash();
70  *
71  * root.put( "normalizeNewlines", new freemarker.template.utility.NormalizeNewlines() );
72  *
73  * ...
74  * </pre>
75  *
76  * <p>From your FreeMarker template:</p>
77  * <pre>
78  * &lt;transform normalizeNewlines&gt;
79  * &lt;html&gt;
80  * &lt;head&gt;
81  * ...
82  * &lt;p&gt;This template has all newlines normalized to the current platform's
83  * default.&lt;/p&gt;
84  * ...
85  * &lt;/body&gt;
86  * &lt;/html&gt;
87  * &lt;/transform&gt;
88  * </pre>
89  *
90  *
91  * @version $Id: NormalizeNewlines.java,v 1.29 2003/04/11 20:57:32 revusky Exp $
92  */
93 public class NormalizeNewlines implements TemplateTransformModel {
94
95     public Writer getWriter(final Writer out,
96                             final Map JavaDoc args)
97     {
98         final StringBuffer JavaDoc buf = new StringBuffer JavaDoc();
99         return new Writer() {
100             public void write(char cbuf[], int off, int len) {
101                 buf.append(cbuf, off, len);
102             }
103
104             public void flush() throws IOException {
105                 out.flush();
106             }
107
108             public void close() throws IOException {
109                 StringReader sr = new StringReader(buf.toString());
110                 StringWriter sw = new StringWriter();
111                 transform(sr, sw);
112                 out.write(sw.toString());
113             }
114         };
115     }
116
117     /**
118      * Performs newline normalization on FreeMarker output.
119      *
120      * @param in the input to be transformed
121      * @param out the destination of the transformation
122      */
123     public void transform(Reader in, Writer out) throws IOException
124     {
125         BufferedReader br = (in instanceof BufferedReader)
126                             ? (BufferedReader) in
127                             : new BufferedReader(in);
128         PrintWriter pw = (out instanceof PrintWriter)
129                          ? (PrintWriter) out
130                          : new PrintWriter(out);
131         String JavaDoc line = br.readLine();
132         if (line != null) {
133             if ( line.length() > 0 ) {
134                 pw.println(line);
135             }
136         }
137         while ((line = br.readLine()) != null) {
138             pw.println(line);
139         }
140     }
141 }
142
Popular Tags