|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
java.io.Writer |
createEscapingWriterFor(java.io.OutputStream out,
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 w,
java.lang.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 |
---|
java.io.Writer createEscapingWriterFor(java.io.Writer w, java.lang.String enc) throws java.io.UnsupportedEncodingException
w
- Underlying writer that the encoding writer should
outputenc
- Encoding to use, as specified by the stream writer
(based on information application has passed)
java.io.UnsupportedEncodingException
java.io.Writer createEscapingWriterFor(java.io.OutputStream out, java.lang.String enc) throws java.io.UnsupportedEncodingException
out
- Underlying stream that the encoding writer should
output usingenc
- Encoding to use, as specified by the stream writer
(based on information application has passed)
java.io.UnsupportedEncodingException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |