com.goldencode.p2j.persist.serial

Class XmlExport.Escaper

java.lang.Object

com.goldencode.p2j.persist.serial.XmlExport.Escaper

All Implemented Interfaces:

org.codehaus.stax2.io.EscapingWriterFactory

Enclosing class:

XmlExport

public static class XmlExport.Escaper
extends java.lang.Object
implements org.codehaus.stax2.io.EscapingWriterFactory

Implementation of the Interface that defines API for the factories stream writers use for creating "escaping writers". These factories are used when defining custom escaping of text (as well as possibly used by the implementations for default escaping too). Escaping in this context refers to the process of replacing individual text/attribute content character with pre-defined and character entities, as per XML specification (2.4, Appendix D). Typical escaping writers replace characters like < and &, as well as some additional characters depending on context. Custom implementations may choose to escape additional characters, for example to make it easier to manually view or edit resulting serialized XML document.

Constructor Summary

Constructors

Constructor and Description
Escaper()

Method Summary

Modifier and Type	Method and Description
java.io.Writer	createEscapingWriterFor(java.io.OutputStream os, java.lang.String enc) Method called to create an instance of escaping writer that will output to the specified stream, using the specified encoding, and escaping necessary characters (depending on both type [attr, element text] and encoding).
java.io.Writer	createEscapingWriterFor(java.io.Writer writer, java.lang.String enc) Method called to create an instance of escaping writer that will output to the specified stream, using the specified encoding, and escaping necessary characters (depending on both type [attr, element text] and encoding).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Escaper

public Escaper()

Method Detail

createEscapingWriterFor

public java.io.Writer createEscapingWriterFor(java.io.OutputStream os,
                                              java.lang.String enc)
                                       throws java.io.UnsupportedEncodingException

Method called to create an instance of escaping writer that will output to the specified stream, using the specified encoding, and escaping necessary characters (depending on both type [attr, element text] and encoding).

Specified by:

createEscapingWriterFor in interface org.codehaus.stax2.io.EscapingWriterFactory

Parameters:

os - Underlying stream that the encoding writer should use for output.

enc - Encoding to use, as specified by the stream writer (based on information application has passed).

Returns:

escaping writer instance

Throws:

java.io.UnsupportedEncodingException

createEscapingWriterFor

public java.io.Writer createEscapingWriterFor(java.io.Writer writer,
                                              java.lang.String enc)
                                       throws java.io.UnsupportedEncodingException

Method called to create an instance of escaping writer that will output to the specified stream, using the specified encoding, and escaping necessary characters (depending on both type [attr, element text] and encoding).

Specified by:

createEscapingWriterFor in interface org.codehaus.stax2.io.EscapingWriterFactory

Parameters:

writer - Underlying writer that the encoding writer should output.

enc - Encoding to use, as specified by the stream writer (based on information application has passed).

Returns:

escaping writer instance

Throws:

java.io.UnsupportedEncodingException