Top Description Methods
org.codehaus.stax2.io

public Interface EscapingWriterFactory

Imports
java.io.OutputStream, .UnsupportedEncodingException, .Writer

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 TypeMethod and Description
public Writer
createEscapingWriterFor(Writer
Underlying writer that the encoding writer should output
w
,
String
Encoding to use, as specified by the stream writer (based on information application has passed)
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).

public Writer
createEscapingWriterFor(OutputStream
Underlying stream that the encoding writer should output using
out
,
String
Encoding to use, as specified by the stream writer (based on information application has passed)
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).

Method Detail

createEscapingWriterForback to summary
public 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:Writer

Underlying writer that the encoding writer should output

enc:String

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

createEscapingWriterForback to summary
public 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:OutputStream

Underlying stream that the encoding writer should output using

enc:String

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