|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||
java.lang.Objectorg.jibx.runtime.impl.XMLWriterNamespaceBase
org.jibx.runtime.impl.StAXWriter
public class StAXWriter
Writer generating StAX parse event stream output.
| Constructor Summary | |
|---|---|
StAXWriter(StAXWriter base,
java.lang.String[] uris)
Copy constructor. |
|
StAXWriter(java.lang.String[] uris)
Constructor. |
|
StAXWriter(java.lang.String[] uris,
javax.xml.stream.XMLStreamWriter wrtr)
Constructor with writer supplied. |
|
| Method Summary | |
|---|---|
void |
addAttribute(int index,
java.lang.String name,
java.lang.String value)
Add attribute to current open start tag. |
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. |
IXMLWriter |
createChildWriter(java.lang.String[] uris)
Create a child writer instance to be used for a separate binding. |
void |
endTag(int index,
java.lang.String name)
Generate end tag. |
void |
flush()
Flush document output. |
void |
indent()
Request output indent. |
void |
init()
Initialize writer. |
void |
setIndentSpaces(int count,
java.lang.String newline,
char indent)
Set nesting indentation. |
void |
setWriter(javax.xml.stream.XMLStreamWriter wrtr)
Set StAX writer. |
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 |
writeCData(java.lang.String text)
Write CDATA text to document. |
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 |
writeTextContent(java.lang.String text)
Write ordinary character data text content 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, reset, translateNamespace |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.jibx.runtime.IXMLWriter |
|---|
getExtensionNamespaces, getNamespaceCount, getNamespacePrefix, getNamespaces, getNamespaceUri, getNestingDepth, getPrefixIndex, openNamespaces, popExtensionNamespaces, popTranslationTable, pushExtensionNamespaces, pushTranslationTable, reset |
| Constructor Detail |
|---|
public StAXWriter(java.lang.String[] uris)
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")
public StAXWriter(java.lang.String[] uris,
javax.xml.stream.XMLStreamWriter wrtr)
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")wrtr - StAX writer for parse event output
public StAXWriter(StAXWriter base,
java.lang.String[] uris)
base - existing instanceuris - ordered array of URIs for namespaces used in document| Method Detail |
|---|
public void init()
init in interface IXMLWriterpublic void setWriter(javax.xml.stream.XMLStreamWriter wrtr)
wrtr - StAX writer for parse event output
public void setIndentSpaces(int count,
java.lang.String newline,
char indent)
IXMLWriter
setIndentSpaces in interface IXMLWritercount - 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
public void writeXMLDecl(java.lang.String version,
java.lang.String encoding,
java.lang.String standalone)
throws java.io.IOException
IXMLWriter
writeXMLDecl in interface IXMLWriterversion - XML version textencoding - text for encoding attribute (unspecified if
null)standalone - text for standalone attribute (unspecified if
null)
java.io.IOException - on error writing to document
public void startTagOpen(int index,
java.lang.String name)
throws java.io.IOException
IXMLWriterIXMLWriter.closeStartTag() call.
startTagOpen in interface IXMLWriterindex - namespace URI index numbername - unqualified element name
java.io.IOException - on error writing to document
public void startTagNamespaces(int index,
java.lang.String name,
int[] nums,
java.lang.String[] prefs)
throws java.io.IOException
IXMLWriter
startTagNamespaces in interface IXMLWriterindex - namespace URI index numbername - element namenums - 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)
java.io.IOException - on error writing to document
public void addAttribute(int index,
java.lang.String name,
java.lang.String value)
throws java.io.IOException
IXMLWriterIXMLWriter.startTagOpen(int, java.lang.String) and before the corresponding call to IXMLWriter.closeStartTag().
addAttribute in interface IXMLWriterindex - namespace URI index numbername - unqualified attribute namevalue - text value for attribute
java.io.IOException - on error writing to document
public void closeStartTag()
throws java.io.IOException
IXMLWriterIXMLWriter.startTagOpen(int, java.lang.String).
closeStartTag in interface IXMLWriterjava.io.IOException - on error writing to document
public void closeEmptyTag()
throws java.io.IOException
IXMLWriterIXMLWriter.startTagOpen(int, java.lang.String).
closeEmptyTag in interface IXMLWriterjava.io.IOException - on error writing to document
public void startTagClosed(int index,
java.lang.String name)
throws java.io.IOException
IXMLWriter
startTagClosed in interface IXMLWriterindex - namespace URI index numbername - unqualified element name
java.io.IOException - on error writing to document
public void endTag(int index,
java.lang.String name)
throws java.io.IOException
IXMLWriter
endTag in interface IXMLWriterindex - namespace URI index numbername - unqualified element name
java.io.IOException - on error writing to document
public void writeTextContent(java.lang.String text)
throws java.io.IOException
IXMLWriter
writeTextContent in interface IXMLWritertext - content value text (must not be null)
java.io.IOException - on error writing to document
public void writeCData(java.lang.String text)
throws java.io.IOException
IXMLWriter
writeCData in interface IXMLWritertext - content value text (must not be null)
java.io.IOException - on error writing to document
public void writeComment(java.lang.String text)
throws java.io.IOException
IXMLWriter
writeComment in interface IXMLWritertext - comment text (must not be null)
java.io.IOException - on error writing to document
public void writeEntityRef(java.lang.String name)
throws java.io.IOException
IXMLWriter
writeEntityRef in interface IXMLWritername - entity name (must not be null)
java.io.IOException - on error writing to document
public void writeDocType(java.lang.String name,
java.lang.String sys,
java.lang.String pub,
java.lang.String subset)
throws java.io.IOException
IXMLWriter
writeDocType in interface IXMLWritername - root element namesys - 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)
java.io.IOException - on error writing to document
public void writePI(java.lang.String target,
java.lang.String data)
throws java.io.IOException
IXMLWriter
writePI in interface IXMLWritertarget - processing instruction target name (must not be
null)data - processing instruction data (must not be null)
java.io.IOException - on error writing to document
public void indent()
throws java.io.IOException
IXMLWriter
indent in interface IXMLWriterjava.io.IOException - on error writing to document
public void flush()
throws java.io.IOException
IXMLWriter
flush in interface IXMLWriterjava.io.IOException - on error writing to document
public void close()
throws java.io.IOException
IXMLWriter
close in interface IXMLWriterjava.io.IOException - on error writing to documentpublic IXMLWriter createChildWriter(java.lang.String[] uris)
createChildWriter in interface IExtensibleWriteruris - ordered array of URIs for namespaces used in document
(see StAXWriter(String[]))
|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||