Class XMLSerializer
- All Implemented Interfaces:
ValidationEventHandler
,ErrorHandler
XmlOutput
.
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" NSDECL* "endNamespaceDecls" ATTRIBUTE* "endAttributes" BODY "endElement" NSDECL := "declareNamespace" ATTRIBUTE := "attribute" ATTVALUES := "text"* 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".
Exceptions in marshaller
IOException
, SAXException
, and XMLStreamException
are thrown from XmlOutput
. They are always considered fatal, and
therefore caught only by MarshallerImpl
.
AccessorException
can be thrown when an access to a property/field
fails, and this is considered as a recoverable error, so it's caught everywhere.
- Author:
- Kohsuke Kawaguchi
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addInscopeBinding
(String nsUri, String prefix) This method can be called afterstartDocument(com.sun.xml.bind.v2.runtime.output.XmlOutput, boolean, java.lang.String, java.lang.String)
is called but before the marshalling begins, to set the currently in-scope namespace bindings.void
attribute
(Name name, CharSequence value) void
void
attWildcardAsAttributes
(Map<QName, String> attributes, String fieldName) void
attWildcardAsURIs
(Map<QName, String> attributes, String fieldName) void
childAsRoot
(Object obj) final void
childAsSoleContent
(Object child, String fieldName) The equivalent of:final void
childAsXsiType
(Object child, String fieldName, JaxBeanInfo expected, boolean nillable) This method is called when a type child object is found.void
Takes care of cleaning the currentProperty.void
close()
void
Switches to the "marshal child texts/elements" mode.void
void
Ends marshalling of an element.void
endNamespaceDecls
(Object innerPeer) void
errorMissingId
(Object obj) Called when a referenced object doesn't have an ID.Deprecated.getCurrentLocation
(String fieldName) May return null when the property hasn't been set.boolean
static XMLSerializer
When called from within the realm of the marshaller, this method returns the currentXMLSerializer
in charge.protected ValidationEventLocator
Gets the current location.boolean
Gets the MIME type with which the binary content shall be printed.boolean
boolean
handleError
(Exception e, Object source, String fieldName) boolean
handleEvent
(ValidationEvent event) void
leafElement
(Name tagName, int data, String fieldName) void
leafElement
(Name tagName, Pcdata data, String fieldName) void
leafElement
(Name tagName, String data, String fieldName) final void
reportError
(String fieldName, Throwable t) Report an error found as an exception.void
setExpectedMimeType
(MimeType expectedMimeType) This method is used byMimeTypedTransducer
to set the expected MIME type for the encapsulatedTransducer
.boolean
setInlineBinaryFlag
(boolean value) void
setObjectIdentityCycleDetection
(boolean val) void
setPrefixMapper
(NamespacePrefixMapper prefixMapper) setSchemaType
(QName st) void
startDocument
(XmlOutput out, boolean fragment, String schemaLocation, String noNsSchemaLocation) Reset this object to write to the specified output.void
startElement
(Name tagName, Object outerPeer) void
startElement
(String nsUri, String localName, String preferredPrefix, Object outerPeer) void
startElementForce
(String nsUri, String localName, String forcedPrefix, Object outerPeer) Variation ofstartElement(String, String, String, Object)
that forces a specific prefix.void
Thetext(String, String)
method that takesPcdata
.void
Marshalls text.<E> void
writeDom
(E element, DomHandler<E, ?> domHandler, Object parentBean, String fieldName) final void
Short for the following call sequence:Methods inherited from class com.sun.xml.bind.v2.runtime.Coordinator
_getInstance, containsAdapter, error, fatalError, getAdapter, popCoordinator, pushCoordinator, putAdapter, warning
-
Field Details
-
grammar
-
nameList
-
knownUri2prefixIndexMap
public final int[] knownUri2prefixIndexMap -
attachmentMarshaller
-
-
Method Details
-
getCachedBase64DataInstance
Deprecated.Base64Data
is no longer cached, so that XMLStreamWriterEx impl can retain the data, like JAX-WS does.Gets the cached instance ofBase64Data
. -
reportError
- Throws:
SAXException
-
reportError
Report an error found as an exception.- Parameters:
fieldName
- the name of the property being processed when an error is found.- Throws:
SAXException
-
startElement
-
startElement
-
startElementForce
public void startElementForce(String nsUri, String localName, String forcedPrefix, Object outerPeer) Variation ofstartElement(String, String, String, Object)
that forces a specific prefix. Needed to preserve the prefix when marshalling DOM. -
endNamespaceDecls
- Throws:
IOException
XMLStreamException
-
endAttributes
Switches to the "marshal child texts/elements" mode. This method has to be called after the 1st pass is completed. -
endElement
Ends marshalling of an element. Pops the internal stack. -
leafElement
public void leafElement(Name tagName, String data, String fieldName) throws SAXException, IOException, XMLStreamException -
leafElement
public void leafElement(Name tagName, Pcdata data, String fieldName) throws SAXException, IOException, XMLStreamException -
leafElement
public void leafElement(Name tagName, int data, String fieldName) throws SAXException, IOException, XMLStreamException -
text
public void text(String text, String fieldName) throws SAXException, IOException, XMLStreamException Marshalls text.This method can be called after the
endAttributes()
method to marshal texts inside elements. If the method is called more than once, those texts are considered as separated by whitespaces. 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>
. -
text
public void text(Pcdata text, String fieldName) throws SAXException, IOException, XMLStreamException Thetext(String, String)
method that takesPcdata
. -
attribute
- Throws:
SAXException
-
attribute
- Throws:
IOException
XMLStreamException
-
getNamespaceContext
-
onID
-
onIDREF
- Throws:
SAXException
-
childAsRoot
public void childAsRoot(Object obj) throws JAXBException, IOException, SAXException, XMLStreamException -
childAsSoleContent
public final void childAsSoleContent(Object child, String fieldName) throws SAXException, IOException, XMLStreamException The equivalent of:childAsURIs(child, fieldName); endNamespaceDecls(); childAsAttributes(child, fieldName); endAttributes(); childAsBody(child, fieldName);
This produces the given child object as the sole content of an element. Used to reduce the code size in the generated marshaller. -
childAsXsiType
public final void childAsXsiType(Object child, String fieldName, JaxBeanInfo expected, boolean nillable) throws SAXException, IOException, XMLStreamException This method is called when a type child object is found.This method produces events of the following form:
NSDECL* "endNamespaceDecls" ATTRIBUTE* "endAttributes" BODY
optionally including @xsi:type if necessary.- Parameters:
child
- Object to be marshalled. TheJaxBeanInfo
for this object must return a type name.expected
- Expected type of the object.fieldName
- property name of the parent objeect from which 'o' comes. Used as a part of the error message in case anything goes wrong with 'o'.- Throws:
SAXException
IOException
XMLStreamException
-
attWildcardAsURIs
-
attWildcardAsAttributes
public void attWildcardAsAttributes(Map<QName, String> attributes, String fieldName) throws SAXException- Throws:
SAXException
-
writeXsiNilTrue
Short for the following call sequence:getNamespaceContext().declareNamespace(WellKnownNamespace.XML_SCHEMA_INSTANCE,"xsi",true); endNamespaceDecls(); attribute(WellKnownNamespace.XML_SCHEMA_INSTANCE,"nil","true"); endAttributes();
-
writeDom
public <E> void writeDom(E element, DomHandler<E, ?> domHandler, Object parentBean, String fieldName) throws SAXException- Throws:
SAXException
-
getIdentityTransformer
-
setPrefixMapper
-
startDocument
public void startDocument(XmlOutput out, boolean fragment, String schemaLocation, String noNsSchemaLocation) throws IOException, SAXException, XMLStreamException Reset this object to write to the specified output.- Parameters:
schemaLocation
- if non-null, this value is printed on the root element as xsi:schemaLocationnoNsSchemaLocation
- Similar to 'schemaLocation' but this one works for xsi:noNamespaceSchemaLocation- Throws:
IOException
SAXException
XMLStreamException
-
endDocument
-
close
public void close() -
addInscopeBinding
This method can be called afterstartDocument(com.sun.xml.bind.v2.runtime.output.XmlOutput, boolean, java.lang.String, java.lang.String)
is called but before the marshalling begins, to set the currently in-scope namespace bindings.This method is useful to avoid redundant namespace declarations when the marshalling is producing a sub-document.
-
getXMIMEContentType
Gets the MIME type with which the binary content shall be printed.This method shall be used from those
RuntimeBuiltinLeafInfo
that are bound to base64Binary. -
setExpectedMimeType
This method is used byMimeTypedTransducer
to set the expected MIME type for the encapsulatedTransducer
. -
setInlineBinaryFlag
public boolean setInlineBinaryFlag(boolean value) -
getInlineBinaryFlag
public boolean getInlineBinaryFlag() -
setSchemaType
-
getSchemaType
-
setObjectIdentityCycleDetection
public void setObjectIdentityCycleDetection(boolean val) -
getObjectIdentityCycleDetection
public boolean getObjectIdentityCycleDetection() -
handleError
-
handleError
-
handleEvent
-
errorMissingId
Called when a referenced object doesn't have an ID.- Throws:
SAXException
-
getCurrentLocation
-
getLocation
Description copied from class:Coordinator
Gets the current location. Used for reporting the error source location.- Specified by:
getLocation
in classCoordinator
-
getCurrentProperty
May return null when the property hasn't been set. Introduced based on Jersey requirements. -
clearCurrentProperty
public void clearCurrentProperty()Takes care of cleaning the currentProperty. Must be called from the same thread that created the XMLSerializer. -
getInstance
When called from within the realm of the marshaller, this method returns the currentXMLSerializer
in charge.
-
Base64Data
is no longer cached, so that XMLStreamWriterEx impl can retain the data, like JAX-WS does.