Interface IXMLWriter

All Known Subinterfaces:
IExtensibleWriter
All Known Implementing Classes:
GenericXMLWriter, ISO88591StreamWriter, JDOMWriter, StAXWriter, StreamWriterBase, UTF8StreamWriter, XMLWriterBase, XMLWriterNamespaceBase

public interface IXMLWriter
XML writer interface used for output of marshalled document. This interface allows easy substitution of different output formats, including parse event stream equivalents. This makes heavy use of state information, so each method call defined is only valid in certain states.
Author:
Dennis M. Sosnoski
  • Method Details

    • init

      void init() throws IOException
      Initialize writer.
      Throws:
      IOException
    • getNestingDepth

      int getNestingDepth()
      Get the current element nesting depth. Elements are only counted in the depth returned when they're officially open - after the start tag has been output and before the end tag has been output.
      Returns:
      number of nested elements at current point in output
    • getNamespaceCount

      int getNamespaceCount()
      Get the number of namespaces currently defined. This is equivalent to the index of the next extension namespace added.
      Returns:
      namespace count
    • setIndentSpaces

      void setIndentSpaces(int count, String newline, char indent)
      Set nesting indentation. This is advisory only, and implementations of this interface are free to ignore it. The intent is to indicate that the generated output should use indenting to illustrate element nesting.
      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

      void writeXMLDecl(String version, String encoding, String standalone) throws IOException
      Write XML declaration to document. This can only be called before any other methods in the interface are called.
      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

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

      void startTagNamespaces(int index, String name, int[] nums, String[] prefs) throws IOException
      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

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

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

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

      void startTagClosed(int index, String name) throws IOException
      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

      void endTag(int index, String name) throws IOException
      Generate end tag.
      Parameters:
      index - namespace URI index number
      name - unqualified element name
      Throws:
      IOException - on error writing to document
    • writeTextContent

      void writeTextContent(String text) throws IOException
      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

      void writeCData(String text) throws IOException
      Write CDATA text to document.
      Parameters:
      text - content value text (must not be null)
      Throws:
      IOException - on error writing to document
    • writeComment

      void writeComment(String text) throws IOException
      Write comment to document.
      Parameters:
      text - comment text (must not be null)
      Throws:
      IOException - on error writing to document
    • writeEntityRef

      void writeEntityRef(String name) throws IOException
      Write entity reference to document.
      Parameters:
      name - entity name (must not be null)
      Throws:
      IOException - on error writing to document
    • writeDocType

      void writeDocType(String name, String sys, String pub, String subset) throws IOException
      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

      void writePI(String target, String data) throws IOException
      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

      void indent() throws IOException
      Request output indent. The writer implementation should normally indent output as appropriate. This method can be used to request indenting of output that might otherwise not be indented. The normal effect when used with a text-oriented writer should be to output the appropriate line end sequence followed by the appropriate number of indent characters for the current nesting level.
      Throws:
      IOException - on error writing to document
    • flush

      void flush() throws IOException
      Flush document output. Writes any buffered data to the output medium. This does not flush the output medium itself, only any internal buffering within the writer.
      Throws:
      IOException - on error writing to document
    • close

      void close() throws IOException
      Close document output. Completes writing of document output, including flushing and closing the output medium.
      Throws:
      IOException - on error writing to document
    • reset

      void reset()
      Reset to initial state for reuse. The writer is serially reusable, as long as this method is called to clear any retained state information between uses.
    • getNamespaces

      String[] getNamespaces()
      Get namespace URIs for mapping. This gets the full ordered array of namespaces known in the binding used for this marshalling, where the index number of each namespace URI is the namespace index used to lookup the prefix when marshalling a name in that namespace. The returned array must not be modified.
      Returns:
      array of namespaces
    • getNamespaceUri

      String getNamespaceUri(int index)
      Get URI for namespace.
      Parameters:
      index - namespace URI index number
      Returns:
      namespace URI text, or null if the namespace index is invalid
    • getNamespacePrefix

      String getNamespacePrefix(int index)
      Get current prefix defined for namespace.
      Parameters:
      index - namespace URI index number
      Returns:
      current prefix text, or null if the namespace is not currently mapped
    • getPrefixIndex

      int getPrefixIndex(String prefix)
      Get index of namespace mapped to prefix. This can be an expensive operation with time proportional to the number of namespaces defined, so it should be used with care.
      Parameters:
      prefix - text to match (non-null, use "" for default prefix)
      Returns:
      index namespace URI index number mapped to prefix
    • pushExtensionNamespaces

      void pushExtensionNamespaces(String[] uris)
      Append extension namespace URIs to those in mapping.
      Parameters:
      uris - namespace URIs to extend those in mapping
    • popExtensionNamespaces

      void popExtensionNamespaces()
      Remove extension namespace URIs. This removes the last set of extension namespaces pushed using pushExtensionNamespaces(java.lang.String[]).
    • getExtensionNamespaces

      String[][] getExtensionNamespaces()
      Get extension namespace URIs added to those in mapping. This gets the current set of extension definitions. The returned arrays must not be modified.
      Returns:
      array of arrays of extension namespaces (null if none)
    • openNamespaces

      int[] openNamespaces(int[] nums, String[] prefs) throws IOException
      Open the specified namespaces for use. This method is normally only called internally, when namespace declarations are actually written to output. It is exposed as part of this interface to allow for special circumstances where namespaces are being written outside the usual processing. The namespaces will remain open for use until the current element is closed.
      Parameters:
      nums - array of namespace indexes defined by this element (reference kept until namespaces are closed, values may be modified by this method)
      prefs - array of namespace prefixes mapped by this element (no null values, use "" for default namespace declaration)
      Returns:
      array of indexes for namespaces not previously active (the ones actually needing to be declared, in the case of text output)
      Throws:
      IOException - on error writing to document
    • pushTranslationTable

      void pushTranslationTable(int[] table)
      Push a translation table to be used for converting namespace index numbers passed as arguments to values used for internal lookup. This allows a layer of indirection between the client code and the namespace definitions, designed for use in supporting precompiled bindings. The translated values must match the internal tables.
      Parameters:
      table - translation table to be used (null if no change)
    • popTranslationTable

      void popTranslationTable()
      Pop a translation table used for converting namespace index numbers to values matching the internal lookup.