Package com.sun.xml.txw2.output
Interface XmlSerializer
- All Known Implementing Classes:
DomSerializer
,DumpSerializer
,SaxSerializer
,StaxSerializer
,StreamSerializer
,TXWSerializer
public interface XmlSerializer
Low-level typeless XML writer driven from
TypedXmlWriter
.
Applications can use one of the predefined implementations to send TXW output to the desired location/format, or they can choose to implement this interface for custom output.
One XmlSerializer
instance is responsible for writing
one XML document.
Call Sequence
TXW calls methods on this interface in the following order:WHOLE_SEQUENCE := startDocument ELEMENT endDocument ELEMENT := beginStartTag writeXmlns* writeAttribute* endStartTag CONTENT endTag CONTENT := (text|ELEMENT)*
TXW maintains all the in-scope namespace bindings and prefix allocation.
The XmlSerializer
implementation should just use the prefix
specified.
- Author:
- Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
beginStartTag
(String uri, String localName, String prefix) Begins writing a start tag.void
cdata
(StringBuilder text) Writes CDATA.void
comment
(StringBuilder comment) Writes a comment.void
The last method to be called.void
endStartTag
(String uri, String localName, String prefix) Completes the start tag.void
endTag()
Writes an end tag.void
flush()
Flush the buffer.void
The first method to be called.void
text
(StringBuilder text) Writes PCDATA.void
writeAttribute
(String uri, String localName, String prefix, StringBuilder value) Writes an attribute.void
writeXmlns
(String prefix, String uri) Writes a namespace declaration.
-
Method Details
-
startDocument
void startDocument()The first method to be called. -
beginStartTag
Begins writing a start tag.- Parameters:
uri
- the namespace URI of the element. Can be empty but never be null.prefix
- the prefix that should be used for this element. Can be empty, but never null.
-
writeAttribute
Writes an attribute.- Parameters:
uri
- the namespace URI of the attribute. Can be empty but never be null.prefix
- the prefix that should be used for this attribute. Can be empty, but never null.value
- The value of the attribute. It's the callee's responsibility to escape special characters (such as <, >, and &) in this buffer.
-
writeXmlns
Writes a namespace declaration.- Parameters:
prefix
- the prefix that is allocated. Can be empty but never be null.uri
- the namespace URI to be declared. Can be empty but never be null.
-
endStartTag
Completes the start tag.- Parameters:
uri
- the namespace URI of the element. Can be empty but never be null.prefix
- the prefix that should be used for this element. Can be empty, but never null.
-
endTag
void endTag()Writes an end tag. -
text
Writes PCDATA.- Parameters:
text
- The character data to be written. It's the callee's responsibility to escape special characters (such as <, >, and &) in this buffer.
-
cdata
Writes CDATA. -
comment
Writes a comment.- Throws:
UnsupportedOperationException
- if the writer doesn't support writing a comment, it can throw this exception.
-
endDocument
void endDocument()The last method to be called. -
flush
void flush()Flush the buffer. This method is called when applications invokeTypedXmlWriter.commit(boolean)
method. If the implementation performs any buffering, it should flush the buffer.
-