Package org.jibx.extras

Class JDOMWriter

java.lang.Object
org.jibx.runtime.impl.XMLWriterNamespaceBase
org.jibx.extras.JDOMWriter
All Implemented Interfaces:
IXMLWriter
public class JDOMWriter extends XMLWriterNamespaceBase
JDOM implementation of XML writer interface. The Document that is created can be accessed by using getDocument().
Version:
1.0
Author:
Andreas Brenk

  • Field Details

    • document

      private Document document
      The JDOM Document this writer is creating.

    • currentElement

      private Element currentElement
      The currently open Element that is used for add* methods.

  • Constructor Details

    • JDOMWriter

      public JDOMWriter(String[] namespaces)
      Creates a new instance with the given namespace URIs.

    • JDOMWriter

      public JDOMWriter(String[] namespaces, Document document)
      Creates a new instance with the given Document as target for marshalling.
      Parameters:
      document - must not be null

    • JDOMWriter

      public JDOMWriter(String[] namespaces, Element currentElement)
      Creates a new instance with the given Element as target for marshalling.
      Parameters:
      currentElement - must not be null

  • Method Details

    • init

      public void init()
      Does nothing.

    • setIndentSpaces

      public void setIndentSpaces(int count, String newline, char indent)
      Does nothing.
      Parameters:
      count - number of character to indent per level, or disable indentation if negative (zero means new line only)
      newline - sequence of characters used for a line ending (null means use the single character '\n')
      indent - whitespace character used for indentation

    • writeXMLDecl

      public void writeXMLDecl(String version, String encoding, String standalone) throws IOException
      Does nothing.
      Parameters:
      version - XML version text
      encoding - text for encoding attribute (unspecified if null)
      standalone - text for standalone attribute (unspecified if null)
      Throws:
      IOException - on error writing to document

    • startTagOpen

      public void startTagOpen(int index, String name) throws IOException
      Description copied from interface: IXMLWriter
      Generate open start tag. This allows attributes and/or namespace declarations to be added to the start tag, but must be followed by a IXMLWriter.closeStartTag() call.
      Parameters:
      index - namespace URI index number
      name - unqualified element name
      Throws:
      IOException - on error writing to document

    • startTagNamespaces

      public void startTagNamespaces(int index, String name, int[] nums, String[] prefs) throws IOException
      Description copied from interface: IXMLWriter
      Generate start tag for element with namespaces. This creates the actual start tag, along with any necessary namespace declarations. Previously active namespace declarations are not duplicated. The tag is left incomplete, allowing other attributes to be added.
      Parameters:
      index - namespace URI index number
      name - element name
      nums - array of namespace indexes defined by this element (must be constant, reference is kept until end of element)
      prefs - array of namespace prefixes mapped by this element (no null values, use "" for default namespace declaration)
      Throws:
      IOException - on error writing to document

    • addAttribute

      public void addAttribute(int index, String name, String value) throws IOException
      Description copied from interface: IXMLWriter
      Add attribute to current open start tag. This is only valid after a call to IXMLWriter.startTagOpen(int, java.lang.String) and before the corresponding call to IXMLWriter.closeStartTag().
      Parameters:
      index - namespace URI index number
      name - unqualified attribute name
      value - text value for attribute
      Throws:
      IOException - on error writing to document

    • closeStartTag

      public void closeStartTag() throws IOException
      Description copied from interface: IXMLWriter
      Close the current open start tag. This is only valid after a call to IXMLWriter.startTagOpen(int, java.lang.String).
      Throws:
      IOException - on error writing to document

    • closeEmptyTag

      public void closeEmptyTag() throws IOException
      Description copied from interface: IXMLWriter
      Close the current open start tag as an empty element. This is only valid after a call to IXMLWriter.startTagOpen(int, java.lang.String).
      Throws:
      IOException - on error writing to document

    • startTagClosed

      public void startTagClosed(int index, String name) throws IOException
      Description copied from interface: IXMLWriter
      Generate closed start tag. No attributes or namespaces can be added to a start tag written using this call.
      Parameters:
      index - namespace URI index number
      name - unqualified element name
      Throws:
      IOException - on error writing to document

    • endTag

      public void endTag(int index, String name) throws IOException
      Description copied from interface: IXMLWriter
      Generate end tag.
      Parameters:
      index - namespace URI index number
      name - unqualified element name
      Throws:
      IOException - on error writing to document

    • writeTextContent

      public void writeTextContent(String text) throws IOException
      Description copied from interface: IXMLWriter
      Write ordinary character data text content to document.
      Parameters:
      text - content value text (must not be null)
      Throws:
      IOException - on error writing to document

    • writeCData

      public void writeCData(String text) throws IOException
      Description copied from interface: IXMLWriter
      Write CDATA text to document.
      Parameters:
      text - content value text (must not be null)
      Throws:
      IOException - on error writing to document

    • writeComment

      public void writeComment(String text) throws IOException
      Description copied from interface: IXMLWriter
      Write comment to document.
      Parameters:
      text - comment text (must not be null)
      Throws:
      IOException - on error writing to document

    • writeEntityRef

      public void writeEntityRef(String name) throws IOException
      Description copied from interface: IXMLWriter
      Write entity reference to document.
      Parameters:
      name - entity name (must not be null)
      Throws:
      IOException - on error writing to document

    • writeDocType

      public void writeDocType(String name, String sys, String pub, String subset) throws IOException
      Description copied from interface: IXMLWriter
      Write DOCTYPE declaration to document.
      Parameters:
      name - root element name
      sys - system ID (null if none, must be non-null for public ID to be used)
      pub - public ID (null if none)
      subset - internal subset (null if none)
      Throws:
      IOException - on error writing to document

    • writePI

      public void writePI(String target, String data) throws IOException
      Description copied from interface: IXMLWriter
      Write processing instruction to document.
      Parameters:
      target - processing instruction target name (must not be null)
      data - processing instruction data (must not be null)
      Throws:
      IOException - on error writing to document

    • indent

      public void indent() throws IOException
      Does nothing.
      Throws:
      IOException - on error writing to document

    • flush

      public void flush() throws IOException
      Does nothing.
      Throws:
      IOException - on error writing to document

    • close

      public void close() throws IOException
      Does nothing.
      Throws:
      IOException - on error writing to document

    • reset

      public void reset()
      Description copied from class: XMLWriterNamespaceBase
      Reset to initial state for reuse. Subclasses overriding this method need to call this base class implementation during their processing.
      Specified by:
      reset in interface IXMLWriter
      Overrides:
      reset in class XMLWriterNamespaceBase

    • getDocument

      public Document getDocument()
      Returns:
      the JDOM Document this writer created.

    • defineNamespace

      protected void defineNamespace(int index, String prefix) throws IOException
      Does nothing.
      Specified by:
      defineNamespace in class XMLWriterNamespaceBase
      Parameters:
      index - post-translation namespace URI index number
      prefix - prefix used for namespace
      Throws:
      IOException - if error writing to document

    • undefineNamespace

      protected void undefineNamespace(int index)
      Does nothing.
      Specified by:
      undefineNamespace in class XMLWriterNamespaceBase
      Parameters:
      index - post-translation namespace URI index number

    • getNamespace

      private Namespace getNamespace(int index)
      This will retrieve (if in existence) or create (if not) a Namespace for the supplied namespace index.