ICharacterEscaper


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;
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      /**
46       * Write attribute value with character entity substitutions. This assumes
47       * that attributes use the regular quote ('"') delimitor.
48       *
49       * @param text attribute value text
50       * @param writer sink for output text
51       * @throws IOException on error writing to document
52       */
53  
54      public void writeAttribute(String   text, Writer   writer) 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) throws IOException  ;
65      
66      /**
67       * Write CDATA to document. This writes the beginning and ending sequences
68       * for a CDATA section as well as the actual text, verifying that only
69       * characters allowed by the encoding are included in the text.
70       *
71       * @param text content value text
72       * @param writer sink for output text
73       * @throws IOException on error writing to document
74       */
75  
76      public void writeCData(String   text, Writer   writer) throws IOException  ;
77  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags