|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.thoughtworks.xstream.io.xml.AbstractXmlWriter
com.thoughtworks.xstream.io.xml.PrettyPrintWriter
public class PrettyPrintWriter
A simple writer that outputs XML in a pretty-printed indented stream.
By default, the chars
are escaped and replaced with a suitable XML entity.
To alter this behavior, override the the writeText(com.thoughtworks.xstream.core.util.QuickWriter, String)
and writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter, String)
methods.
Constructor Summary | |
---|---|
PrettyPrintWriter(java.io.Writer writer)
|
|
PrettyPrintWriter(java.io.Writer writer,
char[] lineIndenter)
|
|
PrettyPrintWriter(java.io.Writer writer,
char[] lineIndenter,
java.lang.String newLine)
|
|
PrettyPrintWriter(java.io.Writer writer,
char[] lineIndenter,
java.lang.String newLine,
XmlFriendlyReplacer replacer)
|
|
PrettyPrintWriter(java.io.Writer writer,
java.lang.String lineIndenter)
|
|
PrettyPrintWriter(java.io.Writer writer,
java.lang.String lineIndenter,
java.lang.String newLine)
|
|
PrettyPrintWriter(java.io.Writer writer,
XmlFriendlyReplacer replacer)
|
Method Summary | |
---|---|
void |
addAttribute(java.lang.String key,
java.lang.String value)
|
void |
close()
Close the writer, if necessary. |
void |
endNode()
|
protected void |
endOfLine()
|
void |
flush()
Flush the writer, if necessary. |
void |
setValue(java.lang.String text)
Write the value (text content) of the current node. |
void |
startNode(java.lang.String name)
|
void |
startNode(java.lang.String name,
java.lang.Class clazz)
|
HierarchicalStreamWriter |
underlyingWriter()
Return the underlying HierarchicalStreamWriter implementation. |
protected void |
writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter writer,
java.lang.String text)
|
protected void |
writeText(com.thoughtworks.xstream.core.util.QuickWriter writer,
java.lang.String text)
|
Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractXmlWriter |
---|
escapeXmlName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrettyPrintWriter(java.io.Writer writer, char[] lineIndenter, java.lang.String newLine, XmlFriendlyReplacer replacer)
public PrettyPrintWriter(java.io.Writer writer, char[] lineIndenter, java.lang.String newLine)
public PrettyPrintWriter(java.io.Writer writer, char[] lineIndenter)
public PrettyPrintWriter(java.io.Writer writer, java.lang.String lineIndenter, java.lang.String newLine)
public PrettyPrintWriter(java.io.Writer writer, java.lang.String lineIndenter)
public PrettyPrintWriter(java.io.Writer writer, XmlFriendlyReplacer replacer)
public PrettyPrintWriter(java.io.Writer writer)
Method Detail |
---|
public void startNode(java.lang.String name)
public void startNode(java.lang.String name, java.lang.Class clazz)
public void setValue(java.lang.String text)
HierarchicalStreamWriter
public void addAttribute(java.lang.String key, java.lang.String value)
protected void writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter writer, java.lang.String text)
protected void writeText(com.thoughtworks.xstream.core.util.QuickWriter writer, java.lang.String text)
public void endNode()
protected void endOfLine()
public void flush()
HierarchicalStreamWriter
public void close()
HierarchicalStreamWriter
public HierarchicalStreamWriter underlyingWriter()
HierarchicalStreamWriter
If a Converter needs to access methods of a specific HierarchicalStreamWriter implementation that are not defined in the HierarchicalStreamWriter interface, it should call this method before casting. This is because the writer passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).
For example:
MySpecificWriter mySpecificWriter = (MySpecificWriter)writer; // INCORRECT! mySpecificWriter.doSomethingSpecific();
MySpecificWriter mySpecificWriter = (MySpecificWriter)writer.underlyingWriter(); // CORRECT! mySpecificWriter.doSomethingSpecific();
Implementations of HierarchicalStreamWriter should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |