Class StaxWriter

All Implemented Interfaces:
ExtendedHierarchicalStreamWriter, HierarchicalStreamWriter, XmlFriendlyWriter

public class StaxWriter extends AbstractXmlWriter
A stream writing that outputs to a StAX stream writer
Version:
$Revision$
  • Field Details

    • qnameMap

      private final QNameMap qnameMap
    • out

      private final XMLStreamWriter out
    • writeEnclosingDocument

      private final boolean writeEnclosingDocument
    • namespaceRepairingMode

      private boolean namespaceRepairingMode
    • tagDepth

      private int tagDepth
  • Constructor Details

    • StaxWriter

      public StaxWriter(QNameMap qnameMap, XMLStreamWriter out) throws XMLStreamException
      Throws:
      XMLStreamException
    • StaxWriter

      public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, NameCoder nameCoder) throws 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:
      XMLStreamException - if the events could not be written to the output
      Since:
      1.4
    • StaxWriter

      public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, NameCoder nameCoder) throws 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:
      XMLStreamException - if the events could not be written to the output
      Since:
      1.4
    • StaxWriter

      public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode) throws 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:
      XMLStreamException - if the events could not be written to the output
    • StaxWriter

      public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer replacer) throws 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:
      XMLStreamException - if the events could not be written to the output
      Since:
      1.2
  • Method Details

    • 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(String name, String value)
    • endNode

      public void endNode()
    • setValue

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

      public void startNode(String name)
    • isNamespaceRepairingMode

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

      protected QNameMap getQNameMap()
    • getXMLStreamWriter

      protected XMLStreamWriter getXMLStreamWriter()