org.codehaus.stax2.io

Interface EscapingWriterFactory

public interface EscapingWriterFactory

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.

Note about implementing escaping writers: writers need to obey normal Writer semantics, and specifically they should pass calls to flush() and close() to the underlying Writer.

Method Summary

Modifier and Type	Method and Description
Writer	createEscapingWriterFor(OutputStream out, 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).
Writer	createEscapingWriterFor(Writer w, String enc) Method called to create an instance of escaping writer that will output content using specified writer, and escaping necessary characters (depending on both type [attr, element text] and encoding).

Method Detail

createEscapingWriterFor

Writer createEscapingWriterFor(Writer w,
                               String enc)
                        throws UnsupportedEncodingException

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

Parameters:

w - Underlying writer that the encoding writer should output

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

Throws:

UnsupportedEncodingException

createEscapingWriterFor

Writer createEscapingWriterFor(OutputStream out,
                               String enc)
                        throws 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).

Parameters:

out - Underlying stream that the encoding writer should output using

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

Throws:

UnsupportedEncodingException