public interface XMLSerializer
This object coordinates the overall marshalling efforts across different content-tree objects and different target formats.
The following CFG gives the proper sequence of method invocation.
MARSHALLING := ELEMENT ELEMENT := "startElement" ATTRIBUTES "endAttributes" BODY "endElement" ATTRIBUTES := ( ATTRIBUTE | NSDECL )* ATTRIBUTE := "startAttribute" ATTVALUES "endAttribute" ATTVALUES := ( "text" | NSDECL )* NSDECL := "declareNamespace" BODY := ( "text" | ELEMENT )*
A marshalling of one element consists of two stages. The first stage is for marshalling attributes and collecting namespace declarations. The second stage is for marshalling characters/child elements of that element.
Observe that multiple invocation of "text" is allowed.
Also observe that the namespace declarations are allowed only between "startElement" and "endAttributes".
Modifier and Type | Method and Description |
---|---|
void |
childAsAttributeBodies(XMLSerializable o)
Deprecated.
This method is called when an XMLSerializable object is found
while the marshaller is in the "attribute body" mode (i.e.
|
void |
childAsAttributes(XMLSerializable o)
Deprecated.
This method is called when an XMLSerializable object is found
while the marshaller is in the "attribute" mode (i.e.
|
void |
childAsElements(XMLSerializable o)
Deprecated.
This method is called when an XMLSerializable object is found
while the marshaller is in the "element" mode (i.e.
|
void |
endAttribute()
Deprecated.
|
void |
endAttributes()
Deprecated.
Switches to the mode to marshal child texts/elements.
|
void |
endElement()
Deprecated.
Ends marshalling of an element.
|
NamespaceContext2 |
getNamespaceContext()
Deprecated.
Obtains a namespace context object, which is used to
declare/obtain namespace bindings.
|
String |
onID(String value)
Deprecated.
Notifies the serializer that an ID value has just marshalled.
|
String |
onIDREF(String value)
Deprecated.
Notifies the serializer that an IDREF value has just marshalled.
|
void |
reportError(ValidationEvent e)
Deprecated.
Errors detected by the XMLSerializable should be either thrown
as
SAXException or reported through this method. |
void |
startAttribute(String uri,
String local)
Deprecated.
Starts marshalling of an attribute.
|
void |
startElement(String uri,
String local)
Deprecated.
Starts marshalling of an element.
|
void |
text(String text)
Deprecated.
Marshalls text.
|
void reportError(ValidationEvent e) throws AbortSerializationException
SAXException
or reported through this method.
The callee should report an error to the client application
andAbortSerializationException
void startElement(String uri, String local) throws SAXException
SAXException
void endAttributes() throws SAXException
SAXException
void endElement() throws SAXException
SAXException
void text(String text) throws SAXException
This method can be called (i) after the startAttribute method and (ii) before the endAttribute method, to marshal attribute values. If the method is called more than once, those texts are considered as separated by whitespaces. For example,
c.startAttribute(); c.text("abc"); c.text("def"); c.endAttribute("","foo");will generate foo="abc def".
Similarly, this method can be called after the endAttributes method to marshal texts inside elements. The same rule about multiple invokations apply to this case, too. For example,
c.startElement("","foo"); c.endAttributes(); c.text("abc"); c.text("def"); c.startElement("","bar"); c.endAttributes(); c.endElement(); c.text("ghi"); c.endElement();will generate
<foo>abc def<bar/>ghi</foo>
.SAXException
void startAttribute(String uri, String local) throws SAXException
SAXException
void endAttribute() throws SAXException
SAXException
NamespaceContext2 getNamespaceContext()
String onID(String value) throws SAXException
SAXException
String onIDREF(String value) throws SAXException
SAXException
void childAsElements(XMLSerializable o) throws SAXException
SAXException
void childAsAttributes(XMLSerializable o) throws SAXException
SAXException
void childAsAttributeBodies(XMLSerializable o) throws SAXException
SAXException
Copyright © 2018 Oracle Corporation. All rights reserved.