01: /*
02: Copyright (c) 2004, Dennis M. Sosnoski.
03: All rights reserved.
04:
05: Redistribution and use in source and binary forms, with or without modification,
06: are permitted provided that the following conditions are met:
07:
08: * Redistributions of source code must retain the above copyright notice, this
09: 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;
30:
31: import java.io.IOException;
32: import java.io.Writer;
33:
34: /**
35: * Escaper for character data to be written to output document. This allows
36: * special character encodings to be handled appropriately on output. It's used
37: * by the generic output handler class during document marshalling.
38: *
39: * @author Dennis M. Sosnoski
40: * @version 1.0
41: */
42:
43: public interface ICharacterEscaper {
44: /**
45: * Write attribute value with character entity substitutions. This assumes
46: * that attributes use the regular quote ('"') delimitor.
47: *
48: * @param text attribute value text
49: * @param writer sink for output text
50: * @throws IOException on error writing to document
51: */
52:
53: public void writeAttribute(String text, Writer writer)
54: throws IOException;
55:
56: /**
57: * Write content value with character entity substitutions.
58: *
59: * @param text content value text
60: * @param writer sink for output text
61: * @throws IOException on error writing to document
62: */
63:
64: public void writeContent(String text, Writer writer)
65: throws IOException;
66:
67: /**
68: * Write CDATA to document. This writes the beginning and ending sequences
69: * for a CDATA section as well as the actual text, verifying that only
70: * characters allowed by the encoding are included in the text.
71: *
72: * @param text content value text
73: * @param writer sink for output text
74: * @throws IOException on error writing to document
75: */
76:
77: public void writeCData(String text, Writer writer)
78: throws IOException;
79: }
|