|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
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.
| Method Summary | |
|---|---|
void |
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 |
endDocument()
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 |
startDocument()
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 Detail |
|---|
void startDocument()
void beginStartTag(String uri,
String localName,
String prefix)
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.
void writeAttribute(String uri,
String localName,
String prefix,
StringBuilder value)
value - The value of the attribute. It's the callee's responsibility to
escape special characters (such as <, >, and &) in this buffer.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.
void writeXmlns(String prefix,
String uri)
uri - the namespace URI to be declared. Can be empty but never be null.prefix - the prefix that is allocated. Can be empty but never be null.
void endStartTag(String uri,
String localName,
String prefix)
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.void endTag()
void text(StringBuilder text)
text - The character data to be written. It's the callee's responsibility to
escape special characters (such as <, >, and &) in this buffer.void cdata(StringBuilder text)
void comment(StringBuilder comment)
UnsupportedOperationException - if the writer doesn't support writing a comment, it can throw this exception.void endDocument()
void flush()
TypedXmlWriter.commit(boolean)
method. If the implementation performs any buffering, it should flush the buffer.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||