USASCIIEscaper


1   /*
2   Copyright (c) 2004, Dennis M. Sosnoski.
3   All rights reserved.
4   
5   Redistribution and use in source and binary forms, with or without modification,
6   are permitted provided that the following conditions are met:
7   
8    * Redistributions of source code must retain the above copyright notice, this
9      list of conditions and the following disclaimer.
10   * Redistributions in binary form must reproduce the above copyright notice,
11     this list of conditions and the following disclaimer in the documentation
12     and/or other materials provided with the distribution.
13   * Neither the name of JiBX nor the names of its contributors may be used
14     to endorse or promote products derived from this software without specific
15     prior written permission.
16  
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28  
29  package org.jibx.runtime.impl;
30  
31  import java.io.IOException  ;
32  import java.io.Writer  ;
33  
34  import org.jibx.runtime.ICharacterEscaper;
35  
36  /**
37   * Handler for writing ASCII output stream. This code is specifically for XML
38   * 1.0 and would require changes for XML 1.1 (to handle the added legal
39   * characters, rather than throwing an exception).
40   *
41   * @author Dennis M. Sosnoski
42   * @version 1.0
43   */
44  
45  public class USASCIIEscaper implements ICharacterEscaper
46  {
47      /** Singleton instance of class. */
48      private static final USASCIIEscaper s_instance = new USASCIIEscaper();
49      
50      /**
51       * Private constructor to prevent external creation.
52       */
53      
54      private USASCIIEscaper() {}
55      
56      /**
57       * Write attribute value with character entity substitutions. This assumes
58       * that attributes use the regular quote ('"') delimitor.
59       *
60       * @param text attribute value text
61       * @param writer sink for output text
62       * @throws IOException on error writing to document
63       */
64  
65      public void writeAttribute(String   text, Writer   writer) throws IOException   {
66          int mark = 0;
67          for (int i = 0; i < text.length(); i++) {
68              char chr = text.charAt(i);
69              if (chr == '"') {
70                  writer.write(text, mark, i-mark);
71                  mark = i+1;
72                  writer.write("&quot;");
73              } else if (chr == '&') {
74                  writer.write(text, mark, i-mark);
75                  mark = i+1;
76                  writer.write("&amp;");
77              } else if (chr == '<') {
78                  writer.write(text, mark, i-mark);
79                  mark = i+1;
80                  writer.write("&lt;");
81              } else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
82                  text.charAt(i-2) == ']') {
83                  writer.write(text, mark, i-mark-2);
84                  mark = i+1;
85                  writer.write("]]&gt;");
86              } else if (chr < 0x20) {
87                  if (chr != 0x9 && chr != 0xA && chr != 0xD) {
88                      throw new IOException  ("Illegal character code 0x" +
89                          Integer.toHexString(chr) + " in attribute value text");
90                  }
91              } else if (chr > 0x7F) {
92                  writer.write(text, mark, i-mark);
93                  mark = i+1;
94                  if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
95                      chr == 0xFFFF || chr > 0x10FFFF)) {
96                      throw new IOException  ("Illegal character code 0x" +
97                          Integer.toHexString(chr) + " in attribute value text");
98                  }
99                  writer.write("&#x");
100                 writer.write(Integer.toHexString(chr));
101                 writer.write(';');
102             }
103         }
104         writer.write(text, mark, text.length()-mark);
105     }
106     
107     /**
108      * Write content value with character entity substitutions.
109      *
110      * @param text content value text
111      * @param writer sink for output text
112      * @throws IOException on error writing to document
113      */
114 
115     public void writeContent(String   text, Writer   writer) throws IOException   {
116         int mark = 0;
117         for (int i = 0; i < text.length(); i++) {
118             char chr = text.charAt(i);
119             if (chr == '&') {
120                 writer.write(text, mark, i-mark);
121                 mark = i+1;
122                 writer.write("&amp;");
123             } else if (chr == '<') {
124                 writer.write(text, mark, i-mark);
125                 mark = i+1;
126                 writer.write("&lt;");
127             } else if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
128                 text.charAt(i-2) == ']') {
129                 writer.write(text, mark, i-mark-2);
130                 mark = i+1;
131                 writer.write("]]&gt;");
132             } else if (chr < 0x20) {
133                 if (chr != 0x9 && chr != 0xA && chr != 0xD) {
134                     throw new IOException  ("Illegal character code 0x" +
135                         Integer.toHexString(chr) + " in content text");
136                 }
137             } else if (chr > 0x7F) {
138                 writer.write(text, mark, i-mark);
139                 mark = i+1;
140                 if (chr > 0xD7FF && (chr < 0xE000 || chr == 0xFFFE ||
141                     chr == 0xFFFF || chr > 0x10FFFF)) {
142                     throw new IOException  ("Illegal character code 0x" +
143                         Integer.toHexString(chr) + " in content text");
144                 }
145                 writer.write("&#x");
146                 writer.write(Integer.toHexString(chr));
147                 writer.write(';');
148             }
149         }
150         writer.write(text, mark, text.length()-mark);
151     }
152     
153     /**
154      * Write CDATA to document. This writes the beginning and ending sequences
155      * for a CDATA section as well as the actual text, verifying that only
156      * characters allowed by the encoding are included in the text.
157      *
158      * @param text content value text
159      * @param writer sink for output text
160      * @throws IOException on error writing to document
161      */
162 
163     public void writeCData(String   text, Writer   writer) throws IOException   {
164         writer.write("<![CDATA[");
165         for (int i = 0; i < text.length(); i++) {
166             char chr = text.charAt(i);
167             if (chr == '>' && i > 2 && text.charAt(i-1) == ']' &&
168                 text.charAt(i-2) == ']') {
169                 throw new IOException  ("Sequence \"]]>\" is not allowed " +
170                     "within CDATA section text");
171             } else if (chr < 0x20) {
172                 if (chr != 0x9 && chr != 0xA && chr != 0xD) {
173                     throw new IOException  ("Illegal character code 0x" +
174                         Integer.toHexString(chr) + " in CDATA section");
175                 }
176             } else if (chr >= 0x80) {
177                 throw new IOException  ("Character code 0x" +
178                     Integer.toHexString(chr) +
179                     " not supported by encoding in CDATA section");
180             }
181         }
182         writer.write(text);
183         writer.write("]]>");
184     }
185     
186     /**
187      * Get instance of escaper.
188      *
189      * @return escaper instance
190      */
191     
192     public static ICharacterEscaper getInstance() {
193         return s_instance;
194     }
195 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags