|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eigenbase.xom.XMLOutput
public class XMLOutput
XMLOutput is a class which implements streaming XML output. Use this class to write XML to any streaming source. While the class itself is unstructured and doesn't enforce any DTD specification, use of the class does ensure that the output is syntactically valid XML.
![]() |
![]() |
Constructor Summary | |
---|---|
XMLOutput(Writer out)
Constructs a new XMLOutput based on any Writer. |
Method Summary | |
---|---|
void |
attribute(String name,
String value)
Write an attribute. |
void |
beginBeginTag(String tagName)
|
void |
beginNode()
If we are currently inside the start tag, finish it off. |
void |
beginTag(String tagName,
XMLAttrVector attributes)
Start writing a new tag to the stream. |
void |
cdata(String data)
Write a CDATA section. |
void |
cdata(String data,
boolean quote)
Writes a CDATA section (as cdata(String) ). |
void |
content(String content)
Write content. |
void |
emptyTag(String tagName,
XMLAttrVector attributes)
Write an empty tag to the stream. |
void |
endBeginTag(String tagName)
|
void |
endTag(String tagName)
Complete a tag. |
boolean |
getCompact()
|
boolean |
getIgnorePcdata()
|
void |
header()
Write header. |
void |
header(String version)
Write header, take version as input. |
int |
numTagsWritten()
Get the total number of tags written |
void |
print(String s)
Sends a string directly to the output stream, without escaping any characters. |
void |
setAlwaysQuoteCData(boolean alwaysQuoteCData)
Sets whether to always quote cdata segments (even if they don't contain special characters). |
void |
setCompact(boolean compact)
Sets or unsets the compact mode. |
void |
setGlob(boolean glob)
Sets whether to detect that tags are empty. |
void |
setIgnorePcdata(boolean ignorePcdata)
Sets whether to ignore unquoted text, such as whitespace. |
void |
setIndentString(String indentString)
Sets the string to print for each level of indentation. |
void |
stringTag(String name,
String data)
Write a String tag; a tag containing nothing but a CDATA section. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XMLOutput(Writer out)
out
- the writer to which this XMLOutput generates results.Method Detail |
---|
public void setCompact(boolean compact)
compact
- true to turn on compact mode, or false to turn it off.public boolean getCompact()
public void setIndentString(String indentString)
null
. Set this to the empty
string to achieve no indentation (note that setCompact(boolean)
(true)
removes indentation and newlines).
public void setGlob(boolean glob)
public void setAlwaysQuoteCData(boolean alwaysQuoteCData)
public void setIgnorePcdata(boolean ignorePcdata)
public boolean getIgnorePcdata()
public void print(String s)
public void beginTag(String tagName, XMLAttrVector attributes)
tagName
- the name of the tag to write.attributes
- an XMLAttrVector containing the attributes to include
in the tag.public void beginBeginTag(String tagName)
public void endBeginTag(String tagName)
public void attribute(String name, String value)
public void beginNode()
public void endTag(String tagName)
tagName
- the name of the end tag to write.public void emptyTag(String tagName, XMLAttrVector attributes)
tagName
- the name of the empty tag.attributes
- an XMLAttrVector containing the attributes to
include in the tag.public void cdata(String data)
&
"
'
<
>
]]>
is special.
]]>
will be enclosed in a CDATA section.
]]>
sequence will be left as-is but have all of its
special characters encoded as entities.
public void cdata(String data, boolean quote)
cdata(String)
).
data
- string to writequote
- if true, quote in a <![CDATA[
... ]]>
regardless of the content of
data
; if false, quote only if the content needs itpublic void stringTag(String name, String data)
public void content(String content)
public void header()
public void header(String version)
public int numTagsWritten()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |