|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface XmlOutput
Well-formed XML writer.
Implementations of this interface is used to connect XMLSerializer
to the actual target. This allows XMLSerializer to be API agnostic.
JAXBContext assigns indices to URIs and local names
that are statically known by using NameList.
XmlOutput implementation can use these indices to improve
the performance. For example, those namespace URI indices can be
turned into prefixes quickly.
XmlOutput still allows arbitrary namepsace URIs / local names
to be written.
The NamespaceContextImpl object, which is shared between XmlOutput and
XMLSerializer, keeps track of the in-scope namespace bindings. By the time
the beginStartTag(com.sun.xml.bind.v2.runtime.Name) method is called, all the namespace bindings for the new
element is already declared. Similarly, after the endTag(com.sun.xml.bind.v2.runtime.Name) method is called,
in-scope bindings will be removed. This book keeping is all done outside XmlOutput.
XmlOutput and XMLSerializer uses indices to
reference prefixes/URIs to be written. NamespaceContextImpl can
convert prefix indices to URIs and the string representations of prefixes.
Binding from indices to URIs and prefixes do not change while indices
are "in scope", so XmlOutput is again expected to take advantage of
this to improve the perofmrnace.
prefix index 0 is reserved for "xml", and this binding is assumed to be always there.
NamespaceContextImpl can handle this index correctly, but this binding will never
be reported to XmlOutput through beginStartTag(com.sun.xml.bind.v2.runtime.Name).
One pecurilar behavior of a NamespaceContextImpl object is that it tries
to define redundant xmlns="" on the root element. Implementations of XmlOutput
is encouraged to check for this and avoid generating redundant namespace declarations.
XMLSerializer calls the writer methods in the following order:
CALLSEQUENCE :=TODO: for FI, consider making attribute values from Strings to CharSequences.startDocumentELEMENTendDocument| ELEMENT // for fragment ELEMENT :=beginStartTagattribute*endStartTagCONTENTSendTagCONTENTS := (ELEMENT |text)*
| Method Summary | |
|---|---|
void |
attribute(int prefix,
java.lang.String localName,
java.lang.String value)
|
void |
attribute(Name name,
java.lang.String value)
|
void |
beginStartTag(int prefix,
java.lang.String localName)
|
void |
beginStartTag(Name name)
Writes a start tag. |
void |
endDocument(boolean fragment)
Called at the very end. |
void |
endStartTag()
|
void |
endTag(int prefix,
java.lang.String localName)
|
void |
endTag(Name name)
|
void |
startDocument(XMLSerializer serializer,
boolean fragment,
int[] nsUriIndex2prefixIndex,
NamespaceContextImpl nsContext)
Called at the very beginning. |
void |
text(Pcdata value,
boolean needsSeparatingWhitespace)
Writes XML text with character escaping, if necessary. |
void |
text(java.lang.String value,
boolean needsSeparatingWhitespace)
Writes XML text with character escaping, if necessary. |
| Method Detail |
|---|
void startDocument(XMLSerializer serializer,
boolean fragment,
int[] nsUriIndex2prefixIndex,
NamespaceContextImpl nsContext)
throws java.io.IOException,
org.xml.sax.SAXException,
javax.xml.stream.XMLStreamException
serializer - the XMLSerializer that coordinates this whole marshalling episode.fragment - true if we are marshalling a fragment.
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException
void endDocument(boolean fragment)
throws java.io.IOException,
org.xml.sax.SAXException,
javax.xml.stream.XMLStreamException
fragment - false if we are writing the whole document.
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException
void beginStartTag(Name name)
throws java.io.IOException,
javax.xml.stream.XMLStreamException
At this point NamespaceContextImpl holds namespace declarations needed for this
new element.
This method is used for writing tags that are indexed.
java.io.IOException
javax.xml.stream.XMLStreamException
void beginStartTag(int prefix,
java.lang.String localName)
throws java.io.IOException,
javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
void attribute(Name name,
java.lang.String value)
throws java.io.IOException,
javax.xml.stream.XMLStreamException
java.io.IOException
javax.xml.stream.XMLStreamException
void attribute(int prefix,
java.lang.String localName,
java.lang.String value)
throws java.io.IOException,
javax.xml.stream.XMLStreamException
prefix - -1 if this attribute does not have a prefix
(this handling differs from that of elements.)
java.io.IOException
javax.xml.stream.XMLStreamException
void endStartTag()
throws java.io.IOException,
org.xml.sax.SAXException
java.io.IOException
org.xml.sax.SAXException
void endTag(Name name)
throws java.io.IOException,
org.xml.sax.SAXException,
javax.xml.stream.XMLStreamException
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException
void endTag(int prefix,
java.lang.String localName)
throws java.io.IOException,
org.xml.sax.SAXException,
javax.xml.stream.XMLStreamException
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException
void text(java.lang.String value,
boolean needsSeparatingWhitespace)
throws java.io.IOException,
org.xml.sax.SAXException,
javax.xml.stream.XMLStreamException
value - this string can contain characters that might need escaping
(such as '&' or '>')needsSeparatingWhitespace -
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException
void text(Pcdata value,
boolean needsSeparatingWhitespace)
throws java.io.IOException,
org.xml.sax.SAXException,
javax.xml.stream.XMLStreamException
value - this string can contain characters that might need escaping
(such as '&' or '>')needsSeparatingWhitespace -
java.io.IOException
org.xml.sax.SAXException
javax.xml.stream.XMLStreamException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||