- java.lang.Object
-
- org.glassfish.jaxb.runtime.v2.runtime.Coordinator
-
- org.glassfish.jaxb.runtime.v2.runtime.XMLSerializer
-
- All Implemented Interfaces:
jakarta.xml.bind.ValidationEventHandler,ErrorHandler
public final class XMLSerializer extends Coordinator
Receives XML serialization event and writes toXmlOutput.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, andXMLStreamExceptionare thrown fromXmlOutput. They are always considered fatal, and therefore caught only byMarshallerImpl.AccessorExceptioncan 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 Modifier and Type Field Description jakarta.xml.bind.attachment.AttachmentMarshallerattachmentMarshallerJAXBContextImplgrammarint[]knownUri2prefixIndexMapNameListnameList
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddInscopeBinding(String nsUri, String prefix)This method can be called afterstartDocument(org.glassfish.jaxb.runtime.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.voidattribute(String uri, String local, String value)voidattribute(Name name, CharSequence value)voidattWildcardAsAttributes(Map<QName,String> attributes, String fieldName)voidattWildcardAsURIs(Map<QName,String> attributes, String fieldName)voidchildAsRoot(Object obj)voidchildAsSoleContent(Object child, String fieldName)The equivalent of:voidchildAsXsiType(Object child, String fieldName, JaxBeanInfo expected, boolean nillable)This method is called when a type child object is found.voidclearCurrentProperty()Takes care of cleaning the currentProperty.voidclose()voidendAttributes()Switches to the "marshal child texts/elements" mode.voidendDocument()voidendElement()Ends marshalling of an element.voidendNamespaceDecls(Object innerPeer)voiderrorMissingId(Object obj)Called when a referenced object doesn't have an ID.Base64DatagetCachedBase64DataInstance()Deprecated.Base64Datais no longer cached, so that XMLStreamWriterEx impl can retain the data, like JAX-WS does.jakarta.xml.bind.ValidationEventLocatorgetCurrentLocation(String fieldName)PropertygetCurrentProperty()May return null when the property hasn't been set.TransformergetIdentityTransformer()booleangetInlineBinaryFlag()static XMLSerializergetInstance()When called from within the realm of the marshaller, this method returns the currentXMLSerializerin charge.protected jakarta.xml.bind.ValidationEventLocatorgetLocation()Gets the current location.NamespaceContext2getNamespaceContext()booleangetObjectIdentityCycleDetection()QNamegetSchemaType()StringgetXMIMEContentType()Gets the MIME type with which the binary content shall be printed.booleanhandleError(Exception e)booleanhandleError(Exception e, Object source, String fieldName)booleanhandleEvent(jakarta.xml.bind.ValidationEvent event)voidleafElement(Name tagName, int data, String fieldName)voidleafElement(Name tagName, String data, String fieldName)voidleafElement(Name tagName, Pcdata data, String fieldName)StringonID(Object owner, String value)StringonIDREF(Object obj)voidreportError(jakarta.xml.bind.ValidationEvent ve)voidreportError(String fieldName, Throwable t)Report an error found as an exception.jakarta.activation.MimeTypesetExpectedMimeType(jakarta.activation.MimeType expectedMimeType)This method is used byMimeTypedTransducerto set the expected MIME type for the encapsulatedTransducer.booleansetInlineBinaryFlag(boolean value)voidsetObjectIdentityCycleDetection(boolean val)voidsetPrefixMapper(NamespacePrefixMapper prefixMapper)QNamesetSchemaType(QName st)voidstartDocument(XmlOutput out, boolean fragment, String schemaLocation, String noNsSchemaLocation)Reset this object to write to the specified output.voidstartElement(String nsUri, String localName, String preferredPrefix, Object outerPeer)voidstartElement(Name tagName, Object outerPeer)voidstartElementForce(String nsUri, String localName, String forcedPrefix, Object outerPeer)Variation ofstartElement(String, String, String, Object)that forces a specific prefix.voidtext(String text, String fieldName)Marshalls text.voidtext(Pcdata text, String fieldName)Thetext(String, String)method that takesPcdata.<E> voidwriteDom(E element, jakarta.xml.bind.annotation.DomHandler<E,?> domHandler, Object parentBean, String fieldName)voidwriteXsiNilTrue()Short for the following call sequence:-
Methods inherited from class org.glassfish.jaxb.runtime.v2.runtime.Coordinator
_getInstance, containsAdapter, error, fatalError, getAdapter, popCoordinator, pushCoordinator, putAdapter, warning
-
-
-
-
Field Detail
-
grammar
public final JAXBContextImpl grammar
-
nameList
public final NameList nameList
-
knownUri2prefixIndexMap
public final int[] knownUri2prefixIndexMap
-
attachmentMarshaller
public jakarta.xml.bind.attachment.AttachmentMarshaller attachmentMarshaller
-
-
Method Detail
-
getCachedBase64DataInstance
public Base64Data getCachedBase64DataInstance()
Deprecated.Base64Datais no longer cached, so that XMLStreamWriterEx impl can retain the data, like JAX-WS does.Gets the cached instance ofBase64Data.
-
reportError
public void reportError(jakarta.xml.bind.ValidationEvent ve) throws SAXException- Throws:
SAXException
-
reportError
public final void reportError(String fieldName, Throwable t) throws SAXException
Report an error found as an exception.- Parameters:
fieldName- the name of the property being processed when an error is found.- Throws:
SAXException
-
startElement
public void startElement(String nsUri, String localName, String preferredPrefix, Object outerPeer)
-
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
public void endNamespaceDecls(Object innerPeer) throws IOException, XMLStreamException
- Throws:
IOExceptionXMLStreamException
-
endAttributes
public void endAttributes() throws SAXException, IOException, XMLStreamExceptionSwitches to the "marshal child texts/elements" mode. This method has to be called after the 1st pass is completed.
-
endElement
public void endElement() throws SAXException, IOException, XMLStreamExceptionEnds 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
public void attribute(String uri, String local, String value) throws SAXException
- Throws:
SAXException
-
attribute
public void attribute(Name name, CharSequence value) throws IOException, XMLStreamException
- Throws:
IOExceptionXMLStreamException
-
getNamespaceContext
public NamespaceContext2 getNamespaceContext()
-
onIDREF
public String onIDREF(Object obj) throws SAXException
- Throws:
SAXException
-
childAsRoot
public void childAsRoot(Object obj) throws jakarta.xml.bind.JAXBException, IOException, SAXException, XMLStreamException
- Throws:
jakarta.xml.bind.JAXBExceptionIOExceptionSAXExceptionXMLStreamException
-
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. TheJaxBeanInfofor 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:
SAXExceptionIOExceptionXMLStreamException
-
attWildcardAsAttributes
public void attWildcardAsAttributes(Map<QName,String> attributes, String fieldName) throws SAXException
- Throws:
SAXException
-
writeXsiNilTrue
public final void writeXsiNilTrue() throws SAXException, IOException, XMLStreamExceptionShort 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, jakarta.xml.bind.annotation.DomHandler<E,?> domHandler, Object parentBean, String fieldName) throws SAXException- Throws:
SAXException
-
getIdentityTransformer
public Transformer getIdentityTransformer()
-
setPrefixMapper
public void setPrefixMapper(NamespacePrefixMapper prefixMapper)
-
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:
IOExceptionSAXExceptionXMLStreamException
-
endDocument
public void endDocument() throws IOException, SAXException, XMLStreamException
-
close
public void close()
-
addInscopeBinding
public void addInscopeBinding(String nsUri, String prefix)
This method can be called afterstartDocument(org.glassfish.jaxb.runtime.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
public String getXMIMEContentType()
Gets the MIME type with which the binary content shall be printed.This method shall be used from those
RuntimeBuiltinLeafInfothat are bound to base64Binary.
-
setExpectedMimeType
public jakarta.activation.MimeType setExpectedMimeType(jakarta.activation.MimeType expectedMimeType)
This method is used byMimeTypedTransducerto set the expected MIME type for the encapsulatedTransducer.
-
setInlineBinaryFlag
public boolean setInlineBinaryFlag(boolean value)
-
getInlineBinaryFlag
public boolean getInlineBinaryFlag()
-
getSchemaType
public QName getSchemaType()
-
setObjectIdentityCycleDetection
public void setObjectIdentityCycleDetection(boolean val)
-
getObjectIdentityCycleDetection
public boolean getObjectIdentityCycleDetection()
-
handleError
public boolean handleError(Exception e)
-
handleEvent
public boolean handleEvent(jakarta.xml.bind.ValidationEvent event)
-
errorMissingId
public void errorMissingId(Object obj) throws SAXException
Called when a referenced object doesn't have an ID.- Throws:
SAXException
-
getCurrentLocation
public jakarta.xml.bind.ValidationEventLocator getCurrentLocation(String fieldName)
-
getLocation
protected jakarta.xml.bind.ValidationEventLocator getLocation()
Description copied from class:CoordinatorGets the current location. Used for reporting the error source location.- Specified by:
getLocationin classCoordinator
-
getCurrentProperty
public Property 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
public static XMLSerializer getInstance()
When called from within the realm of the marshaller, this method returns the currentXMLSerializerin charge.
-
-