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

Field Summary

Fields inherited from class org.jibx.runtime.impl.XMLWriterNamespaceBase

m_prefixes, m_uris

Constructor Summary

Constructors

Constructor and Description
XMLWriterBase(String[] uris) Constructor.
XMLWriterBase(XMLWriterBase base, String[] uris) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(int index, String name, 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, String name) Generate end tag.
protected void	flagContent() Set up for writing any content to element.
protected void	flagTextContent() Set up for writing text content to element.
abstract void	flush() Flush document output.
protected abstract void	indent(int bias) Request output indent with bias from current element nesting level.
void	init() Initialize writer.
void	reset() Reset to initial state for reuse.
void	startTagClosed(int index, String name) Generate closed start tag.
void	startTagNamespaces(int index, String name, int[] nums, String[] prefs) Generate start tag for element with namespaces.
void	startTagOpen(int index, String name) Generate open start tag.
protected abstract void	writeAttributeText(String text) Write attribute text to output.
void	writeComment(String text) Write comment to document.
void	writeDocType(String name, String sys, String pub, String subset) Write DOCTYPE declaration to document.
void	writeEntityRef(String name) Write entity reference to document.
protected abstract void	writeMarkup(char chr) Write markup character to output.
protected abstract void	writeMarkup(String text) Write markup text to output.
void	writePI(String target, String data) Write processing instruction to document.
protected abstract void	writePrefix(int index) Write namespace prefix to output.
void	writeXMLDecl(String version, String encoding, String standalone) Write XML declaration to document.

Methods inherited from class org.jibx.runtime.impl.XMLWriterNamespaceBase

decrementNesting, defineNamespace, getExtensionNamespaces, getNamespaceCount, getNamespacePrefix, getNamespaces, getNamespaceUri, getNestingDepth, getPrefixIndex, growArray, incrementNesting, internalNamespacePrefix, internalNamespaceUri, internalSetUris, openNamespaces, popExtensionNamespaces, popTranslationTable, pushExtensionNamespaces, pushTranslationTable, shrinkArray, translateNamespace, undefineNamespace

Methods inherited from class java.lang.Object

clone, equals, finalize, 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(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,
             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

writeMarkup

protected abstract void writeMarkup(String text)
                             throws IOException

Write markup text to output. Markup text can be written directly to the output without the need for any escaping, but still needs to be properly encoded.

Parameters:

text - markup text to be written

Throws:

IOException - if error writing to document

writeMarkup

protected abstract void writeMarkup(char chr)
                             throws IOException

Write markup character to output. Markup text can be written directly to the output without the need for any escaping, but still needs to be properly encoded.

Parameters:

chr - markup character to be written

Throws:

IOException - if error writing to document

writePrefix

protected abstract void writePrefix(int index)
                             throws IOException

Write namespace prefix to output. This internal method is used to throw an exception when an undeclared prefix is used.

Parameters:

index - namespace URI index number

Throws:

IOException - if error writing to document

writeAttributeText

protected abstract void writeAttributeText(String text)
                                    throws IOException

Write attribute text to output. This needs to write the text with any appropriate escaping.

Parameters:

text - attribute value text to be written

Throws:

IOException - if error writing to document

indent

protected abstract void indent(int bias)
                        throws IOException

Request output indent with bias from current element nesting level. This is used internally for proper indenting in special cases.

Throws:

IOException - on error writing to document

flagContent

protected final void flagContent()
                          throws IOException

Set up for writing any content to element. If the start tag for the element has not been closed, this will close it.

Throws:

IOException - on error writing to document

flagTextContent

protected final void flagTextContent()
                              throws IOException

Set up for writing text content to element. If the start tag for the element has not been closed, this will close it.

Throws:

IOException - on error writing to document

init

public void init()

Initialize writer.

Specified by:

init in interface IXMLWriter

writeXMLDecl

public 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.

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:

IOException - on error writing to document

startTagOpen

public void startTagOpen(int index,
                String name)
                  throws 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:

IOException - on error writing to document

startTagNamespaces

public 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.

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:

IOException - on error writing to document

addAttribute

public 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) 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:

IOException - on error writing to document

closeStartTag

public void closeStartTag()
                   throws 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:

IOException - on error writing to document

closeEmptyTag

public 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).

Specified by:

closeEmptyTag in interface IXMLWriter

Throws:

IOException - on error writing to document

startTagClosed

public 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.

Specified by:

startTagClosed in interface IXMLWriter

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

Generate end tag.

Specified by:

endTag in interface IXMLWriter

Parameters:

index - namespace URI index number

name - unqualified element name

Throws:

IOException - on error writing to document

writeComment

public void writeComment(String text)
                  throws IOException

Write comment to document.

Specified by:

writeComment in interface IXMLWriter

Parameters:

text - comment text

Throws:

IOException - on error writing to document

writeEntityRef

public void writeEntityRef(String name)
                    throws IOException

Write entity reference to document.

Specified by:

writeEntityRef in interface IXMLWriter

Parameters:

name - entity name

Throws:

IOException - on error writing to document

writeDocType

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

IOException - on error writing to document

writePI

public void writePI(String target,
           String data)
             throws IOException

Write processing instruction to document.

Specified by:

writePI in interface IXMLWriter

Parameters:

target - processing instruction target name

data - processing instruction data

Throws:

IOException - on error writing to document

flush

public abstract void flush()
                    throws 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:

IOException - on error writing to document

close

public abstract void close()
                    throws IOException

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

Specified by:

close in interface IXMLWriter

Throws:

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