XMLWriterBase (JiBX Java data binding to XML - Version 1.2.3)
Keywords: org.jibx.runtime.impl.XMLWriterBase class

Overview | Package | Class | Deprecated
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jibx.runtime.impl
Class XMLWriterBase

    java.lang.Object
      org.jibx.runtime.impl.XMLWriterNamespaceBase
          org.jibx.runtime.impl.XMLWriterBase

All Implemented Interfaces:
  IExtensibleWriter, IXMLWriter

Direct Known Subclasses:
  GenericXMLWriter, StreamWriterBase

    public abstract class XMLWriterBase

extends XMLWriterNamespaceBase
implements IExtensibleWriter

Base implementation of XML writer interface. This provides common handling of indentation and formatting that can be used for all forms of text output.

Author:
  Dennis M. Sosnoski

Constructor Summary
`XMLWriterBase(java.lang.String[] uris)` Constructor.
`XMLWriterBase(XMLWriterBase base, java.lang.String[] uris)` Copy constructor.

Method Summary
`void` | `addAttribute(int index, java.lang.String name, java.lang.String value)` Add attribute to current open start tag.
`abstract void` | `close()` Close document output.
`void` | `closeEmptyTag()` Close the current open start tag as an empty element.
`void` | `closeStartTag()` Close the current open start tag.
`void` | `endTag(int index, java.lang.String name)` Generate end tag.
`abstract void` | `flush()` Flush document output.
`void` | `init()` Initialize writer.
`void` | `reset()` Reset to initial state for reuse.
`void` | `startTagClosed(int index, java.lang.String name)` Generate closed start tag.
`void` | `startTagNamespaces(int index, java.lang.String name, int[] nums, java.lang.String[] prefs)` Generate start tag for element with namespaces.
`void` | `startTagOpen(int index, java.lang.String name)` Generate open start tag.
`void` | `writeComment(java.lang.String text)` Write comment to document.
`void` | `writeDocType(java.lang.String name, java.lang.String sys, java.lang.String pub, java.lang.String subset)` Write DOCTYPE declaration to document.
`void` | `writeEntityRef(java.lang.String name)` Write entity reference to document.
`void` | `writePI(java.lang.String target, java.lang.String data)` Write processing instruction to document.
`void` | `writeXMLDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone)` Write XML declaration to document.

Methods inherited from class org.jibx.runtime.impl.XMLWriterNamespaceBase
`getExtensionNamespaces, getNamespaceCount, getNamespacePrefix, getNamespaces, getNamespaceUri, getNestingDepth, getPrefixIndex, openNamespaces, popExtensionNamespaces, popTranslationTable, pushExtensionNamespaces, pushTranslationTable, translateNamespace`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.jibx.runtime.IExtensibleWriter
`createChildWriter`

Methods inherited from interface org.jibx.runtime.IXMLWriter
`getExtensionNamespaces, getNamespaceCount, getNamespacePrefix, getNamespaces, getNamespaceUri, getNestingDepth, getPrefixIndex, indent, openNamespaces, popExtensionNamespaces, popTranslationTable, pushExtensionNamespaces, pushTranslationTable, setIndentSpaces, writeCData, writeTextContent`

Constructor Detail

### XMLWriterBase

    public XMLWriterBase(java.lang.String[] uris)

  Constructor.

  Parameters:
    `uris` - ordered array of URIs for namespaces used in document (must be constant; the value in position 0 must always be the empty string "", and the value in position 1 must always be the XML namespace "http://www.w3.org/XML/1998/namespace")

### XMLWriterBase

    public XMLWriterBase(XMLWriterBase base,
                         java.lang.String[] uris)

  Copy constructor. This initializes the extension namespace information from an existing instance.

  Parameters:
    `base` - existing instance
    `uris` - ordered array of URIs for namespaces used in document

Method Detail

### init

    public void init()

  Initialize writer.

  Specified by:
    `init` in interface `IXMLWriter`

### writeXMLDecl

    public void writeXMLDecl(java.lang.String version,
                             java.lang.String encoding,
                             java.lang.String standalone)
                      throws java.io.IOException

  Write XML declaration to document. This can only be called before any other methods in the interface are called.

  Specified by:
    `writeXMLDecl` in interface `IXMLWriter`
  Parameters:
    `version` - XML version text
    `encoding` - text for encoding attribute (unspecified if `null`)
    `standalone` - text for standalone attribute (unspecified if `null`)
  Throws:
    `java.io.IOException` - on error writing to document

### startTagOpen

    public void startTagOpen(int index,
                             java.lang.String name)
                      throws java.io.IOException

  Generate open start tag. This allows attributes to be added to the start tag, but must be followed by a `closeStartTag()` call.

  Specified by:
    `startTagOpen` in interface `IXMLWriter`
  Parameters:
    `index` - namespace URI index number
    `name` - unqualified element name
  Throws:
    `java.io.IOException` - on error writing to document

### startTagNamespaces

    public void startTagNamespaces(int index,
                                   java.lang.String name,
                                   int[] nums,
                                   java.lang.String[] prefs)
                            throws java.io.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.

  Specified by:
    `startTagNamespaces` in interface `IXMLWriter`
  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:
    `java.io.IOException` - on error writing to document

### addAttribute

    public void addAttribute(int index,
                             java.lang.String name,
                             java.lang.String value)
                      throws java.io.IOException

  Add attribute to current open start tag. This is only valid after a call to `startTagOpen(int, java.lang.String)` or `startTagNamespaces(int, java.lang.String, int[], java.lang.String[])` and before the corresponding call to `closeStartTag()`.

  Specified by:
    `addAttribute` in interface `IXMLWriter`
  Parameters:
    `index` - namespace URI index number
    `name` - unqualified attribute name
    `value` - text value for attribute
  Throws:
    `java.io.IOException` - on error writing to document

### closeStartTag

    public void closeStartTag()
                       throws java.io.IOException

  Close the current open start tag. This is only valid after a call to `startTagOpen(int, java.lang.String)`.

  Specified by:
    `closeStartTag` in interface `IXMLWriter`
  Throws:
    `java.io.IOException` - on error writing to document

### closeEmptyTag

    public void closeEmptyTag()
                       throws java.io.IOException

  Close the current open start tag as an empty element. This is only valid after a call to `startTagOpen(int, java.lang.String)`.

  Specified by:
    `closeEmptyTag` in interface `IXMLWriter`
  Throws:
    `java.io.IOException` - on error writing to document

### startTagClosed

    public void startTagClosed(int index,
                               java.lang.String name)
                        throws java.io.IOException

  Generate closed start tag. No attributes or namespaces can be added to a start tag written using this call.

  Specified by:
    `startTagClosed` in interface `IXMLWriter`
  Parameters:
    `index` - namespace URI index number
    `name` - unqualified element name
  Throws:
    `java.io.IOException` - on error writing to document

### endTag

    public void endTag(int index,
                       java.lang.String name)
                throws java.io.IOException

  Generate end tag.

  Specified by:
    `endTag` in interface `IXMLWriter`
  Parameters:
    `index` - namespace URI index number
    `name` - unqualified element name
  Throws:
    `java.io.IOException` - on error writing to document

### writeComment

    public void writeComment(java.lang.String text)
                      throws java.io.IOException

  Write comment to document.

  Specified by:
    `writeComment` in interface `IXMLWriter`
  Parameters:
    `text` - comment text
  Throws:
    `java.io.IOException` - on error writing to document

### writeEntityRef

    public void writeEntityRef(java.lang.String name)
                        throws java.io.IOException

  Write entity reference to document.

  Specified by:
    `writeEntityRef` in interface `IXMLWriter`
  Parameters:
    `name` - entity name
  Throws:
    `java.io.IOException` - on error writing to document

### writeDocType

    public void writeDocType(java.lang.String name,
                             java.lang.String sys,
                             java.lang.String pub,
                             java.lang.String subset)
                      throws java.io.IOException

  Write DOCTYPE declaration to document.

  Specified by:
    `writeDocType` in interface `IXMLWriter`
  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:
    `java.io.IOException` - on error writing to document

### writePI

    public void writePI(java.lang.String target,
                        java.lang.String data)
                 throws java.io.IOException

  Write processing instruction to document.

  Specified by:
    `writePI` in interface `IXMLWriter`
  Parameters:
    `target` - processing instruction target name
    `data` - processing instruction data
  Throws:
    `java.io.IOException` - on error writing to document

### flush

    public abstract void flush()
                        throws java.io.IOException

  Flush document output. Subclasses must implement this method to force all buffered output to be written. To assure proper handling of an open start tag they should first call `flagContent()`.

  Specified by:
    `flush` in interface `IXMLWriter`
  Throws:
    `java.io.IOException` - on error writing to document

### close

    public abstract void close()
                        throws java.io.IOException

  Close document output. Completes writing of document output, including closing the output medium.

  Specified by:
    `close` in interface `IXMLWriter`
  Throws:
    `java.io.IOException` - on error writing to document

### reset

    public 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. It is automatically called when output is set.

  Specified by:
    `reset` in interface `IXMLWriter`
  Overrides:
    `reset` in class `XMLWriterNamespaceBase`

Overview | Package | Class | Deprecated
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Project Web Site |