Package org.dom4j.io

Class STAXEventWriter

  • public class STAXEventWriter
extends java.lang.Object
    Writes DOM4J Nodes to a StAX event stream. In addition the createXXX methods are provided to directly create STAX events from DOM4J nodes.

    • Constructor Detail

      • STAXEventWriter

        public STAXEventWriter()

      • STAXEventWriter

        public STAXEventWriter(java.io.File file)
                throws javax.xml.stream.XMLStreamException,
                       java.io.IOException
        Constructs a STAXEventWriter that writes events to the provided file.
        Parameters:
        file - The file to which events will be written.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs creating an event writer from the file.
        java.io.IOException - If an error occurs openin the file for writing.

      • STAXEventWriter

        public STAXEventWriter(java.io.Writer writer)
                throws javax.xml.stream.XMLStreamException
        Constructs a STAXEventWriter that writes events to the provided character stream.
        Parameters:
        writer - The character stream to which events will be written.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs constructing an event writer from the character stream.

      • STAXEventWriter

        public STAXEventWriter(java.io.OutputStream stream)
                throws javax.xml.stream.XMLStreamException
        Constructs a STAXEventWriter that writes events to the provided stream.
        Parameters:
        stream - The output stream to which events will be written.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs constructing an event writer from the stream.

      • STAXEventWriter

        public STAXEventWriter(javax.xml.stream.util.XMLEventConsumer consumer)
        Constructs a STAXEventWriter that writes events to the provided event stream.
        Parameters:
        consumer - The event stream to which events will be written.

    • Method Detail

      • getConsumer

        public javax.xml.stream.util.XMLEventConsumer getConsumer()
        Returns a reference to the underlying event consumer to which events are written.
        Returns:
        The underlying event consumer to which events are written.

      • setConsumer

        public void setConsumer(javax.xml.stream.util.XMLEventConsumer consumer)
        Sets the underlying event consumer to which events are written.
        Parameters:
        consumer - The event consumer to which events should be written.

      • getEventFactory

        public javax.xml.stream.XMLEventFactory getEventFactory()
        Returns a reference to the event factory used to construct STAX events.
        Returns:
        The event factory used to construct STAX events.

      • setEventFactory

        public void setEventFactory(javax.xml.stream.XMLEventFactory eventFactory)
        Sets the event factory used to construct STAX events.
        Parameters:
        eventFactory - The new event factory.

      • writeNode

        public void writeNode(Node n)
               throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Nodeto the stream. This method is simply a gateway to the overloaded methods such as writeElement(Element).
        Parameters:
        n - The DOM4J Nodeto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • writeChildNodes

        public void writeChildNodes(Branch branch)
                     throws javax.xml.stream.XMLStreamException
        Writes each child node within the provided Branchinstance. This method simply iterates through the Branch's nodes and calls writeNode(Node).
        Parameters:
        branch - The node whose children will be written to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • writeElement

        public void writeElement(Element elem)
                  throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Elementnode and its children to the stream.
        Parameters:
        elem - The Elementnode to write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createStartElement

        public javax.xml.stream.events.StartElement createStartElement(Element elem)
        Constructs a STAX StartElementevent from a DOM4J Element.
        Parameters:
        elem - The Elementfrom which to construct the event.
        Returns:
        The newly constructed StartElementevent.

      • createEndElement

        public javax.xml.stream.events.EndElement createEndElement(Element elem)
        Constructs a STAX EndElementevent from a DOM4J Element.
        Parameters:
        elem - The Elementfrom which to construct the event.
        Returns:
        The newly constructed EndElementevent.

      • writeAttribute

        public void writeAttribute(Attribute attr)
                    throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Attributeto the stream.
        Parameters:
        attr - The Attributeto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createAttribute

        public javax.xml.stream.events.Attribute createAttribute(Attribute attr)
        Constructs a STAX Attributeevent from a DOM4J Attribute.
        Parameters:
        attr - The Attributefrom which to construct the event.
        Returns:
        The newly constructed Attribute event.

      • writeNamespace

        public void writeNamespace(Namespace ns)
                    throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Namespaceto the stream.
        Parameters:
        ns - The Namespaceto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createNamespace

        public javax.xml.stream.events.Namespace createNamespace(Namespace ns)
        Constructs a STAX Namespaceevent from a DOM4J Namespace.
        Parameters:
        ns - The Namespacefrom which to construct the event.
        Returns:
        The constructed Namespaceevent.

      • writeText

        public void writeText(Text text)
               throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Textto the stream.
        Parameters:
        text - The Textto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createCharacters

        public javax.xml.stream.events.Characters createCharacters(Text text)
        Constructs a STAX Charactersevent from a DOM4J Text.
        Parameters:
        text - The Textfrom which to construct the event.
        Returns:
        The constructed Charactersevent.

      • writeCDATA

        public void writeCDATA(CDATA cdata)
                throws javax.xml.stream.XMLStreamException
        Writes a DOM4J CDATAto the event stream.
        Parameters:
        cdata - The CDATAto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createCharacters

        public javax.xml.stream.events.Characters createCharacters(CDATA cdata)
        Constructs a STAX Charactersevent from a DOM4J CDATA.
        Parameters:
        cdata - The CDATAfrom which to construct the event.
        Returns:
        The newly constructed Charactersevent.

      • writeComment

        public void writeComment(Comment comment)
                  throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Commentto the stream.
        Parameters:
        comment - The Commentto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createComment

        public javax.xml.stream.events.Comment createComment(Comment comment)
        Constructs a STAX Commentevent from a DOM4J Comment.
        Parameters:
        comment - The Commentfrom which to construct the event.
        Returns:
        The constructed Commentevent.

      • writeProcessingInstruction

        public void writeProcessingInstruction(ProcessingInstruction pi)
                                throws javax.xml.stream.XMLStreamException
        Writes a DOM4J ProcessingInstructionto the stream.
        Parameters:
        pi - The ProcessingInstructionto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createProcessingInstruction

        public javax.xml.stream.events.ProcessingInstruction createProcessingInstruction(ProcessingInstruction pi)
        Constructs a STAX ProcessingInstruction event from a DOM4J ProcessingInstruction.
        Parameters:
        pi - The ProcessingInstructionfrom which to construct the event.
        Returns:
        The constructed ProcessingInstruction event.

      • writeEntity

        public void writeEntity(Entity entity)
                 throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Entityto the stream.
        Parameters:
        entity - The Entityto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • writeDocumentType

        public void writeDocumentType(DocumentType docType)
                       throws javax.xml.stream.XMLStreamException
        Writes a DOM4J DocumentTypeto the stream.
        Parameters:
        docType - The DocumentTypeto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createDTD

        public javax.xml.stream.events.DTD createDTD(DocumentType docType)
        Constructs a STAX DTDevent from a DOM4J DocumentType.
        Parameters:
        docType - The DocumentTypefrom which to construct the event.
        Returns:
        The constructed DTDevent.
        Throws:
        java.lang.RuntimeException - DOCUMENT ME!

      • writeDocument

        public void writeDocument(Document doc)
                   throws javax.xml.stream.XMLStreamException
        Writes a DOM4J Documentnode, and all its contents, to the stream.
        Parameters:
        doc - The Documentto write to the stream.
        Throws:
        javax.xml.stream.XMLStreamException - If an error occurs writing to the stream.

      • createStartDocument

        public javax.xml.stream.events.StartDocument createStartDocument(Document doc)
        Constructs a STAX StartDocumentevent from a DOM4J Document.
        Parameters:
        doc - The Documentfrom which to construct the event.
        Returns:
        The constructed StartDocumentevent.

      • createEndDocument

        public javax.xml.stream.events.EndDocument createEndDocument(Document doc)
        Constructs a STAX EndDocumentevent from a DOM4J Document.
        Parameters:
        doc - The Documentfrom which to construct the event.
        Returns:
        The constructed EndDocumentevent.

      • createQName

        public javax.xml.namespace.QName createQName(QName qname)
        Constructs a STAX QNamefrom a DOM4J QName.
        Parameters:
        qname - The QNamefrom which to construct the STAX QName.
        Returns:
        The constructed QName.