XStream Core 1.4.20 · com.thoughtworks.xstream.io.xml.PrettyPrintWriter

A simple writer that outputs XML in a pretty-printed indented stream.

By default, the chars
& < > " ' \r
are escaped and replaced with a suitable XML entity. To alter this behavior, override the writeText(com.thoughtworks.xstream.core.util.QuickWriter, String) and writeAttributeValue(com.thoughtworks.xstream.core.util.QuickWriter, String) methods.

The XML specification requires XML parsers to drop CR characters completely. This implementation will therefore use only a LF for line endings, never the platform encoding. You can overwrite the getNewLine() method for a different behavior.

Note

Depending on the XML version some characters cannot be written. Especially a 0 character is never valid in XML, neither directly nor as entity nor within CDATA. However, this writer works by default in a quirks mode, where it will write any character at least as character entity (even a null character). You may switch into XML_1_1 mode (which supports most characters) or XML_1_0 that does only support a very limited number of control characters. See XML specification for version 1.0 or 1.1. If a character is not supported, a StreamException is thrown. Select a proper parser implementation that respects the version in the XML header (the Xpp3 parser will also read character entities of normally invalid characters).

Field Summary

Modifier and Type	Field and Description
private static final char[]	AMP
private static final char[]	APOS
private static final char[]	CLOSE
private static final char[]	CR
protected int	depth
private final FastStack	elementStack
private static final char[]	GT
private final char[]	lineIndenter
private static final char[]	LT
private final int	mode
private String	newLine
private static final char[]	NULL
private static final char[]	QUOT
private boolean	readyForNewLine
private boolean	tagInProgress
private boolean	tagIsEmpty
private final QuickWriter	writer
public static int	XML_1_0
public static int	XML_1_1
public static int	XML_QUIRKS

Constructor Summary

Access	Constructor and Description
private	PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, NameCoder nameCoder, String newLine)
public	PrettyPrintWriter(Writer writer, char[] lineIndenter, String newLine, XmlFriendlyReplacer replacer) Deprecated As of 1.3
public	PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, NameCoder nameCoder)
public	PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, XmlFriendlyReplacer replacer) Deprecated As of 1.4 use `PrettyPrintWriter#PrettyPrintWriter(Writer, int, char[], NameCoder)` instead
public	PrettyPrintWriter(Writer writer, char[] lineIndenter, String newLine) Deprecated As of 1.3
public	PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter)
public	PrettyPrintWriter(Writer writer, char[] lineIndenter)
public	PrettyPrintWriter(Writer writer, String lineIndenter, String newLine) Deprecated As of 1.3
public	PrettyPrintWriter(Writer writer, int mode, String lineIndenter)
public	PrettyPrintWriter(Writer writer, String lineIndenter)
public	PrettyPrintWriter(Writer writer, int mode, NameCoder nameCoder)
public	PrettyPrintWriter(Writer writer, int mode, XmlFriendlyReplacer replacer) Deprecated As of 1.4 use `PrettyPrintWriter#PrettyPrintWriter(Writer, int, NameCoder)` instead
public	PrettyPrintWriter(Writer writer, NameCoder nameCoder)
public	PrettyPrintWriter(Writer writer, XmlFriendlyReplacer replacer) Deprecated As of 1.4 use `PrettyPrintWriter#PrettyPrintWriter(Writer, NameCoder)` instead.
public	PrettyPrintWriter(Writer writer, int mode)
public	PrettyPrintWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
public void	addAttribute(String key, String value) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.addAttribute.
public void	close() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.close. Close the writer, if necessary.
public void	endNode() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.endNode.
protected void	endOfLine()
private void	finishTag()
public void	flush() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.flush. Flush the writer, if necessary.
protected String	Returns: the line terminator getNewLine() Retrieve the line terminator.
public void	setValue(String text) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.setValue. Write the value (text content) of the current node.
public void	startNode(String name) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.startNode.
public void	startNode(String name, Class<T> clazz) Overrides com.thoughtworks.xstream.io.AbstractWriter.startNode. Implements com.thoughtworks.xstream.io.ExtendedHierarchicalStreamWriter.startNode.
protected void	writeAttributeValue(QuickWriter writer, String text)
protected void	writeText(QuickWriter writer, String text)
private void	writeText(String text, boolean isAttribute)

Inherited from com.thoughtworks.xstream.io.xml.AbstractXmlWriter:: escapeXmlName

Field Detail

AMP	back to summary
private static final char[] AMP

APOS	back to summary
private static final char[] APOS

CLOSE	back to summary
private static final char[] CLOSE

CR	back to summary
private static final char[] CR

depth	back to summary
protected int depth

elementStack	back to summary
private final FastStack elementStack

GT	back to summary
private static final char[] GT

lineIndenter	back to summary
private final char[] lineIndenter

LT	back to summary
private static final char[] LT

mode	back to summary
private final int mode

newLine	back to summary
private String newLine

NULL	back to summary
private static final char[] NULL

QUOT	back to summary
private static final char[] QUOT

readyForNewLine	back to summary
private boolean readyForNewLine

tagInProgress	back to summary
private boolean tagInProgress

tagIsEmpty	back to summary
private boolean tagIsEmpty

writer	back to summary
private final QuickWriter writer

XML_1_0	back to summary
public static int XML_1_0

XML_1_1	back to summary
public static int XML_1_1

XML_QUIRKS	back to summary
public static int XML_QUIRKS

Constructor Detail

PrettyPrintWriter	back to summary
private PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, NameCoder nameCoder, String newLine)

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, char[] lineIndenter, String newLine, XmlFriendlyReplacer replacer) Deprecated As of 1.3 Since 1.2

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, NameCoder nameCoder) Since 1.4

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, XmlFriendlyReplacer replacer) Deprecated As of 1.4 use `PrettyPrintWriter#PrettyPrintWriter(Writer, int, char[], NameCoder)` instead Since 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, char[] lineIndenter, String newLine) Deprecated As of 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter) Since 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, char[] lineIndenter)

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, String lineIndenter, String newLine) Deprecated As of 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode, String lineIndenter) Since 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, String lineIndenter)

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode, NameCoder nameCoder) Since 1.4

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode, XmlFriendlyReplacer replacer) Deprecated As of 1.4 use `PrettyPrintWriter#PrettyPrintWriter(Writer, int, NameCoder)` instead Since 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, NameCoder nameCoder) Since 1.4

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, XmlFriendlyReplacer replacer) Deprecated As of 1.4 use `PrettyPrintWriter#PrettyPrintWriter(Writer, NameCoder)` instead.

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer, int mode) Since 1.3

PrettyPrintWriter	back to summary
public PrettyPrintWriter(Writer writer)

Method Detail

addAttribute	back to summary
public void addAttribute(String key, String value) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.addAttribute.

close	back to summary
public void close() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.close. Doc from com.thoughtworks.xstream.io.HierarchicalStreamWriter.close. Close the writer, if necessary.

back to summary

public void close()

Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.close.

Doc from com.thoughtworks.xstream.io.HierarchicalStreamWriter.close.

Close the writer, if necessary.

endNode	back to summary
public void endNode() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.endNode.

endOfLine	back to summary
protected void endOfLine()

finishTag	back to summary
private void finishTag()

flush	back to summary
public void flush() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.flush. Doc from com.thoughtworks.xstream.io.HierarchicalStreamWriter.flush. Flush the writer, if necessary.

flush

back to summary

public void flush()

Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.flush.

Doc from com.thoughtworks.xstream.io.HierarchicalStreamWriter.flush.

Flush the writer, if necessary.

getNewLine	back to summary
protected String getNewLine() Retrieve the line terminator. This method returns always a line feed, since according the XML specification any parser must ignore a carriage return. Overload this method, if you need different behavior. Returns:String the line terminator Since 1.3

getNewLine

back to summary

protected String getNewLine()

Retrieve the line terminator. This method returns always a line feed, since according the XML specification any parser must ignore a carriage return. Overload this method, if you need different behavior.

Returns:String: the line terminator
Since: 1.3

setValue	back to summary
public void setValue(String text) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.setValue. Doc from com.thoughtworks.xstream.io.HierarchicalStreamWriter.setValue. Write the value (text content) of the current node.

setValue

back to summary

public void setValue(String text)

Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.setValue.

Doc from com.thoughtworks.xstream.io.HierarchicalStreamWriter.setValue.

Write the value (text content) of the current node.

startNode	back to summary
public void startNode(String name) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.startNode.

startNode	back to summary
public void startNode(String name, Class<T> clazz) Overrides com.thoughtworks.xstream.io.AbstractWriter.startNode. Implements com.thoughtworks.xstream.io.ExtendedHierarchicalStreamWriter.startNode.

startNode

back to summary

public void startNode(String name, Class<T> clazz)

Overrides com.thoughtworks.xstream.io.AbstractWriter.startNode.

Implements com.thoughtworks.xstream.io.ExtendedHierarchicalStreamWriter.startNode.

writeAttributeValue	back to summary
protected void writeAttributeValue(QuickWriter writer, String text)

writeText	back to summary
protected void writeText(QuickWriter writer, String text)

writeText	back to summary
private void writeText(String text, boolean isAttribute)

public Class PrettyPrintWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail