Class XMLStreamWriterRecord

  • All Implemented Interfaces:
    org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord, org.eclipse.persistence.internal.oxm.record.MarshalRecord, org.eclipse.persistence.internal.oxm.record.XMLRecord

    public class XMLStreamWriterRecord
    extends MarshalRecord

    Use this type of MarshalRecord when the marshal target is an XMLStreamWriter

    XMLContext xmlContext = new XMLContext("session-name");
    XMLMarshaller xmlMarshaller = xmlContext.createMarshaller();
    XMLStreamWriterRecord writerRecord = new XMLStreamWriterRecord(xmlStreamWriter);
    xmlMarshaller.marshal(myObject, writerRecord);

    See Also:
    XMLMarshaller
    • Constructor Detail

      • XMLStreamWriterRecord

        public XMLStreamWriterRecord​(XMLStreamWriter xmlStreamWriter)
    • Method Detail

      • setXMLStreamWriter

        public void setXMLStreamWriter​(XMLStreamWriter anXMLStreamWriter)
      • attribute

        public void attribute​(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                              org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver,
                              String value)
        Description copied from class: MarshalRecord
        Receive notification of an attribute.
        Specified by:
        attribute in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Specified by:
        attribute in class MarshalRecord
        Parameters:
        xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.
        namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).
        value - This is the complete value for the attribute.
      • namespaceDeclaration

        public void namespaceDeclaration​(String prefix,
                                         String namespaceURI)
        Description copied from class: MarshalRecord
        Add the specified namespace declaration
        Specified by:
        namespaceDeclaration in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
        Specified by:
        namespaceDeclaration in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Overrides:
        namespaceDeclaration in class MarshalRecord
      • attributeWithoutQName

        public void attributeWithoutQName​(String namespaceURI,
                                          String localName,
                                          String prefix,
                                          String value)
        Specified by:
        attributeWithoutQName in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
        Specified by:
        attributeWithoutQName in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Overrides:
        attributeWithoutQName in class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
      • attribute

        public void attribute​(String namespaceURI,
                              String localName,
                              String name,
                              String value)
        Description copied from class: MarshalRecord
        Receive notification of an attribute.
        Specified by:
        attribute in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
        Specified by:
        attribute in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Specified by:
        attribute in class MarshalRecord
        Parameters:
        namespaceURI - The namespace URI, if the attribute is not namespace qualified the value of this parameter wil be null.
        localName - The local name of the attribute.
        name - The qualified name of the attribute.
        value - This is the complete value for the attribute.
      • cdata

        public void cdata​(String value)
        Description copied from class: MarshalRecord
        Receive notification of character data to be wrapped in a CDATA node.
        Specified by:
        cdata in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Specified by:
        cdata in class MarshalRecord
        Parameters:
        value - This is the value of the text to be wrapped
      • characters

        public void characters​(String value)
        Description copied from class: MarshalRecord
        Receive notification of character data.
        Specified by:
        characters in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Specified by:
        characters in class MarshalRecord
        Parameters:
        value - This is the entire value of the text node.
      • isNamespaceAware

        public boolean isNamespaceAware()
        Description copied from class: org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
        Determine if namespaces will be considered during marshal/unmarshal operations.
        Specified by:
        isNamespaceAware in interface org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecord
        Specified by:
        isNamespaceAware in interface org.eclipse.persistence.internal.oxm.record.XMLRecord
        Overrides:
        isNamespaceAware in class org.eclipse.persistence.internal.oxm.record.AbstractMarshalRecordImpl
      • closeStartElement

        public void closeStartElement()
        Description copied from class: MarshalRecord
        Receive notification that all of the attribute events have occurred for the most recent element that has been started.
        Specified by:
        closeStartElement in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Specified by:
        closeStartElement in class MarshalRecord
      • openStartElement

        public void openStartElement​(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                                     org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
        Description copied from class: MarshalRecord
        Receive notification that an element is being started.
        Specified by:
        openStartElement in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Overrides:
        openStartElement in class MarshalRecord
        Parameters:
        xPathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.
        namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).
      • element

        public void element​(org.eclipse.persistence.internal.oxm.XPathFragment frag)
        Description copied from class: MarshalRecord
        Receive notification of an element.
        Specified by:
        element in class MarshalRecord
        Parameters:
        frag - The XPathFragment of the element
      • endDocument

        public void endDocument()
        Description copied from class: MarshalRecord
        Recieve notification that a document is being ended.
        Specified by:
        endDocument in class MarshalRecord
      • endElement

        public void endElement​(org.eclipse.persistence.internal.oxm.XPathFragment pathFragment,
                               org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
        Description copied from class: MarshalRecord
        Receive notification that an element is being ended.
        Specified by:
        endElement in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Specified by:
        endElement in class MarshalRecord
        Parameters:
        pathFragment - The XPathFragment contains the name and prefix information about the XML element being ended.
        namespaceResolver - The NamespaceResolver can be used to resolve the namespace URI for the namespace prefix held by the XPathFragment (if required).
      • node

        public void node​(Node node,
                         org.eclipse.persistence.internal.oxm.NamespaceResolver resolver,
                         String uri,
                         String name)
        Description copied from class: MarshalRecord
        Receive notification of a node.
        Specified by:
        node in class MarshalRecord
        Parameters:
        node - The Node to be added to the document
        resolver - The NamespaceResolver can be used to resolve the
        uri - replacement root name for the node
        name - replacement root namespace for the node namespace URI/prefix of the node
      • startDocument

        public void startDocument​(String encoding,
                                  String version)
        Description copied from class: MarshalRecord
        Receive notification that a document is being started.
        Specified by:
        startDocument in class MarshalRecord
        Parameters:
        encoding - The XML document will be encoded using this encoding.
        version - This specifies the version of XML.
      • startPrefixMapping

        public void startPrefixMapping​(String prefix,
                                       String namespaceUri)
        Description copied from class: MarshalRecord
        Receive notification that a namespace has been declared.
        Specified by:
        startPrefixMapping in interface org.eclipse.persistence.internal.oxm.record.MarshalRecord
        Overrides:
        startPrefixMapping in class MarshalRecord
        Parameters:
        prefix - The namespace prefix.
        namespaceUri - The namespace URI.
      • namespaceDeclarations

        public void namespaceDeclarations​(org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
        Description copied from class: MarshalRecord
        INTERNAL: Add the namespace declarations to the XML document.
        Overrides:
        namespaceDeclarations in class MarshalRecord
        Parameters:
        namespaceResolver - The NamespaceResolver contains the namespace prefix and URI pairings that need to be declared.
      • startPrefixMappings

        public void startPrefixMappings​(org.eclipse.persistence.internal.oxm.NamespaceResolver namespaceResolver)
        Overrides:
        startPrefixMappings in class MarshalRecord