KickJava   Java API By Example, From Geeks To Geeks.

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


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 java.io.IOException JavaDoc;
56 import java.io.Writer JavaDoc;
57 import java.util.Map JavaDoc;
58
59 import freemarker.template.TemplateTransformModel;
60
61 /**
62  * Performs an XML escaping of a given template fragment. Specifically,
63  * < > &quot ' and & are all turned into entity references.
64  *
65  * <p>An instance of this tarnsform is initially visible as shared
66  * variable called <tt>xml_escape</tt>.</p>
67  *
68  * @version $Id: XmlEscape.java,v 1.29 2004/11/27 14:49:57 ddekany Exp $
69  */
70 public class XmlEscape implements TemplateTransformModel {
71
72     private static final char[] LT = "&lt;".toCharArray();
73     private static final char[] GT = "&gt;".toCharArray();
74     private static final char[] AMP = "&amp;".toCharArray();
75     private static final char[] QUOT = "&quot;".toCharArray();
76     private static final char[] APOS = "&apos;".toCharArray();
77
78     public Writer JavaDoc getWriter(final Writer JavaDoc out, Map JavaDoc args)
79     {
80         return new Writer JavaDoc()
81         {
82             public void write(char c)
83             throws
84                 IOException JavaDoc
85             {
86                 switch(c)
87                 {
88                     case '<': out.write(LT, 0, 4); break;
89                     case '>': out.write(GT, 0, 4); break;
90                     case '&': out.write(AMP, 0, 5); break;
91                     case '"': out.write(QUOT, 0, 6); break;
92                     case '\'': out.write(APOS, 0, 6); break;
93                     default: out.write(c);
94                 }
95             }
96
97             public void write(char cbuf[], int off, int len)
98             throws
99                 IOException JavaDoc
100             {
101                 int lastoff = off;
102                 int lastpos = off + len;
103                 for (int i = off; i < lastpos; i++)
104                 {
105                     switch (cbuf[i])
106                     {
107                         case '<': out.write(cbuf, lastoff, i - lastoff); out.write(LT, 0, 4); lastoff = i + 1; break;
108                         case '>': out.write(cbuf, lastoff, i - lastoff); out.write(GT, 0, 4); lastoff = i + 1; break;
109                         case '&': out.write(cbuf, lastoff, i - lastoff); out.write(AMP, 0, 5); lastoff = i + 1; break;
110                         case '"': out.write(cbuf, lastoff, i - lastoff); out.write(QUOT, 0, 6); lastoff = i + 1; break;
111                         case '\'': out.write(cbuf, lastoff, i - lastoff); out.write(APOS, 0, 6); lastoff = i + 1; break;
112                     }
113                 }
114                 int remaining = lastpos - lastoff;
115                 if(remaining > 0)
116                 {
117                     out.write(cbuf, lastoff, remaining);
118                 }
119             }
120             public void flush() throws IOException JavaDoc {
121                 out.flush();
122             }
123
124             public void close() {
125             }
126         };
127     }
128 }
129
Popular Tags