Class StaxWriter

    • Field Detail

      • qnameMap

        private final QNameMap qnameMap
      • out

        private final javax.xml.stream.XMLStreamWriter out
      • writeEnclosingDocument

        private final boolean writeEnclosingDocument
      • namespaceRepairingMode

        private boolean namespaceRepairingMode
      • tagDepth

        private int tagDepth
    • Constructor Detail

      • StaxWriter

        public StaxWriter​(QNameMap qnameMap,
                          javax.xml.stream.XMLStreamWriter out)
                   throws javax.xml.stream.XMLStreamException
        Throws:
        javax.xml.stream.XMLStreamException
      • StaxWriter

        public StaxWriter​(QNameMap qnameMap,
                          javax.xml.stream.XMLStreamWriter out,
                          NameCoder nameCoder)
                   throws javax.xml.stream.XMLStreamException
        Allows a StaxWriter to be created for partial XML output
        Parameters:
        qnameMap - is the mapper of Java class names to QNames
        out - the stream to output to
        nameCoder - the xml-friendly replacer to escape Java names
        Throws:
        javax.xml.stream.XMLStreamException - if the events could not be written to the output
        Since:
        1.4
      • StaxWriter

        public StaxWriter​(QNameMap qnameMap,
                          javax.xml.stream.XMLStreamWriter out,
                          boolean writeEnclosingDocument,
                          boolean namespaceRepairingMode,
                          NameCoder nameCoder)
                   throws javax.xml.stream.XMLStreamException
        Allows a StaxWriter to be created for partial XML output
        Parameters:
        qnameMap - is the mapper of Java class names to QNames
        out - the stream to output to
        writeEnclosingDocument - a flag to indicate whether or not the start/end document events should be written
        namespaceRepairingMode - a flag to enable StAX' namespace repairing mode
        nameCoder - the xml-friendly replacer to escape Java names
        Throws:
        javax.xml.stream.XMLStreamException - if the events could not be written to the output
        Since:
        1.4
      • StaxWriter

        public StaxWriter​(QNameMap qnameMap,
                          javax.xml.stream.XMLStreamWriter out,
                          boolean writeEnclosingDocument,
                          boolean namespaceRepairingMode)
                   throws javax.xml.stream.XMLStreamException
        Allows a StaxWriter to be created for partial XML output
        Parameters:
        qnameMap - is the mapper of Java class names to QNames
        out - the stream to output to
        writeEnclosingDocument - a flag to indicate whether or not the start/end document events should be written
        Throws:
        javax.xml.stream.XMLStreamException - if the events could not be written to the output
      • StaxWriter

        public StaxWriter​(QNameMap qnameMap,
                          javax.xml.stream.XMLStreamWriter out,
                          boolean writeEnclosingDocument,
                          boolean namespaceRepairingMode,
                          XmlFriendlyReplacer replacer)
                   throws javax.xml.stream.XMLStreamException
        Allows a StaxWriter to be created for partial XML output
        Parameters:
        qnameMap - is the mapper of Java class names to QNames
        out - the stream to output to
        writeEnclosingDocument - a flag to indicate whether or not the start/end document events should be written
        replacer - the xml-friendly replacer to escape Java names
        Throws:
        javax.xml.stream.XMLStreamException - if the events could not be written to the output
        Since:
        1.2
    • Method Detail

      • flush

        public void flush()
        Description copied from interface: HierarchicalStreamWriter
        Flush the writer, if necessary.
      • close

        public void close()
        Call this method when you're finished with me
      • addAttribute

        public void addAttribute​(java.lang.String name,
                                 java.lang.String value)
      • endNode

        public void endNode()
      • setValue

        public void setValue​(java.lang.String text)
        Description copied from interface: HierarchicalStreamWriter
        Write the value (text content) of the current node.
      • startNode

        public void startNode​(java.lang.String name)
      • isNamespaceRepairingMode

        public boolean isNamespaceRepairingMode()
        Is StAX namespace repairing mode on or off?
      • getQNameMap

        protected QNameMap getQNameMap()
      • getXMLStreamWriter

        protected javax.xml.stream.XMLStreamWriter getXMLStreamWriter()