| java.lang.Object
 org.jibx.runtime.impl.XMLWriterNamespaceBase
org.jibx.runtime.impl.XMLWriterBase
All known Subclasses: org.jibx.runtime.impl.GenericXMLWriter, org.jibx.runtime.impl.StreamWriterBase,
| XMLWriterBase | | abstract public class XMLWriterBase extends XMLWriterNamespaceBase (Code) | | 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
version:
1.0 |
| Method Summary | |
| public void | addAttribute(int index, String name, String value)
Add attribute to current open start tag. | | abstract public void | close()
Close document output. | | public void | closeEmptyTag()
Close the current open start tag as an empty element. | | public void | closeStartTag()
Close the current open start tag. | | abstract public IXMLWriter | createChildWriter(String[] uris)
Create a child writer instance to be used for a separate binding. | | public void | endTag(int index, String name)
Generate end tag. | | final protected void | flagContent()
Set up for writing any content to element. | | final protected void | flagTextContent()
Set up for writing text content to element. | | abstract public void | flush()
Flush document output. | | abstract protected void | indent(int bias)
Request output indent with bias from current element nesting level. | | public void | reset()
Reset to initial state for reuse. | | public void | startTagClosed(int index, String name)
Generate closed start tag. | | public void | startTagNamespaces(int index, String name, int[] nums, String[] prefs)
Generate start tag for element with namespaces. | | public void | startTagOpen(int index, String name)
Generate open start tag. | | abstract protected void | writeAttributeText(String text)
Write attribute text to output. | | public void | writeComment(String text)
Write comment to document. | | public void | writeDocType(String name, String sys, String pub, String subset)
Write DOCTYPE declaration to document. | | public void | writeEntityRef(String name)
Write entity reference to document. | | abstract protected void | writeMarkup(String text)
Write markup text to output. | | abstract protected void | writeMarkup(char chr)
Write markup character to output. | | public void | writePI(String target, String data)
Write processing instruction to document. | | abstract protected void | writePrefix(int index)
Write namespace prefix to output. | | public void | writeXMLDecl(String version, String encoding, String standalone)
Write XML declaration to document. |
| XMLWriterBase | | public XMLWriterBase(String[] uris)(Code) | | Constructor.
Parameters:
uris - ordered array of URIs for namespaces used in document (mustbe 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)(Code) | | Copy constructor. This initializes the extension namespace information
from an existing instance.
Parameters:
base - existing instance
Parameters:
uris - ordered array of URIs for namespaces used in document |
| close | | abstract public void close() throws IOException(Code) | | Close document output. Completes writing of document output, including
closing the output medium.
throws:
IOException - on error writing to document |
| createChildWriter | | abstract public IXMLWriter createChildWriter(String[] uris)(Code) | | Create a child writer instance to be used for a separate binding. The
child writer inherits the stream and encoding from this writer, while
using the supplied namespace URIs.
Parameters:
uris - ordered array of URIs for namespaces used in document(see XMLWriterBase.XMLWriterBase(String[])) child writer |
| endTag | | public void endTag(int index, String name) throws IOException(Code) | | Generate end tag.
Parameters:
index - namespace URI index number
Parameters:
name - unqualified element name
throws:
IOException - on error writing to document |
| flagContent | | final protected void flagContent() throws IOException(Code) | | 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 | | final protected void flagTextContent() throws IOException(Code) | | 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 |
| flush | | abstract public void flush() throws IOException(Code) | | Flush document output. Forces out all output generated to this point.
throws:
IOException - on error writing to document |
| indent | | abstract protected void indent(int bias) throws IOException(Code) | | 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 |
| reset | | public void reset()(Code) | | 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.
|
| startTagClosed | | public void startTagClosed(int index, String name) throws IOException(Code) | | 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
Parameters:
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(Code) | | 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
Parameters:
name - element name
Parameters:
nums - array of namespace indexes defined by this element (mustbe constant, reference is kept until end of element)
Parameters:
prefs - array of namespace prefixes mapped by this element (nonull values, use "" for default namespace declaration)
throws:
IOException - on error writing to document |
| startTagOpen | | public void startTagOpen(int index, String name) throws IOException(Code) | | Generate open start tag. This allows attributes to be added to the start
tag, but must be followed by a
XMLWriterBase.closeStartTag call.
Parameters:
index - namespace URI index number
Parameters:
name - unqualified element name
throws:
IOException - on error writing to document |
| writeAttributeText | | abstract protected void writeAttributeText(String text) throws IOException(Code) | | 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 |
| writeComment | | public void writeComment(String text) throws IOException(Code) | | Write comment to document.
Parameters:
text - comment text
throws:
IOException - on error writing to document |
| writeDocType | | public void writeDocType(String name, String sys, String pub, String subset) throws IOException(Code) | | Write DOCTYPE declaration to document.
Parameters:
name - root element name
Parameters:
sys - system ID (null if none, must benon-null for public ID to be used)
Parameters:
pub - public ID (null if none)
Parameters:
subset - internal subset (null if none)
throws:
IOException - on error writing to document |
| writeEntityRef | | public void writeEntityRef(String name) throws IOException(Code) | | Write entity reference to document.
Parameters:
name - entity name
throws:
IOException - on error writing to document |
| writeMarkup | | abstract protected void writeMarkup(String text) throws IOException(Code) | | 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 | | abstract protected void writeMarkup(char chr) throws IOException(Code) | | 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 |
| writePI | | public void writePI(String target, String data) throws IOException(Code) | | Write processing instruction to document.
Parameters:
target - processing instruction target name
Parameters:
data - processing instruction data
throws:
IOException - on error writing to document |
| writePrefix | | abstract protected void writePrefix(int index) throws IOException(Code) | | 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 |
| writeXMLDecl | | public void writeXMLDecl(String version, String encoding, String standalone) throws IOException(Code) | | Write XML declaration to document. This can only be called before any
other methods in the interface are called.
Parameters:
version - XML version text
Parameters:
encoding - text for encoding attribute (unspecified ifnull)
Parameters:
standalone - text for standalone attribute (unspecified ifnull)
throws:
IOException - on error writing to document |
|
|