public class PrettyPrintWriter extends AbstractXmlWriter
By default, the chars
are escaped and replaced with a suitable XML entity. To alter this behavior, override
the the
& < > " ' \r
writeText(edu.internet2.middleware.grouperClientExt.com.thoughtworks.xstream.core.util.QuickWriter, String)
and
writeAttributeValue(edu.internet2.middleware.grouperClientExt.com.thoughtworks.xstream.core.util.QuickWriter, String)
methods.
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).
Modifier and Type | Field and Description |
---|---|
protected int |
depth |
static int |
XML_1_0 |
static int |
XML_1_1 |
static int |
XML_QUIRKS |
Constructor and Description |
---|
PrettyPrintWriter(Writer writer) |
PrettyPrintWriter(Writer writer,
char[] lineIndenter) |
PrettyPrintWriter(Writer writer,
char[] lineIndenter,
String newLine)
Deprecated.
since 1.3
|
PrettyPrintWriter(Writer writer,
char[] lineIndenter,
String newLine,
XmlFriendlyReplacer replacer)
Deprecated.
since 1.3
|
PrettyPrintWriter(Writer writer,
int mode) |
PrettyPrintWriter(Writer writer,
int mode,
char[] lineIndenter) |
PrettyPrintWriter(Writer writer,
int mode,
char[] lineIndenter,
XmlFriendlyReplacer replacer) |
PrettyPrintWriter(Writer writer,
int mode,
String lineIndenter) |
PrettyPrintWriter(Writer writer,
int mode,
XmlFriendlyReplacer replacer) |
PrettyPrintWriter(Writer writer,
String lineIndenter) |
PrettyPrintWriter(Writer writer,
String lineIndenter,
String newLine)
Deprecated.
since 1.3
|
PrettyPrintWriter(Writer writer,
XmlFriendlyReplacer replacer) |
Modifier and Type | Method and Description |
---|---|
void |
addAttribute(String key,
String value) |
void |
close()
Close the writer, if necessary.
|
void |
endNode() |
protected void |
endOfLine() |
void |
flush()
Flush the writer, if necessary.
|
protected String |
getNewLine() |
void |
setValue(String text)
Write the value (text content) of the current node.
|
void |
startNode(String name) |
void |
startNode(String name,
Class clazz) |
protected void |
writeAttributeValue(QuickWriter writer,
String text) |
protected void |
writeText(QuickWriter writer,
String text) |
escapeXmlName, underlyingWriter
public static int XML_QUIRKS
public static int XML_1_0
public static int XML_1_1
protected int depth
public PrettyPrintWriter(Writer writer, char[] lineIndenter, String newLine, XmlFriendlyReplacer replacer)
public PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter, XmlFriendlyReplacer replacer)
public PrettyPrintWriter(Writer writer, char[] lineIndenter, String newLine)
public PrettyPrintWriter(Writer writer, int mode, char[] lineIndenter)
public PrettyPrintWriter(Writer writer, char[] lineIndenter)
public PrettyPrintWriter(Writer writer, String lineIndenter, String newLine)
public PrettyPrintWriter(Writer writer, int mode, XmlFriendlyReplacer replacer)
public PrettyPrintWriter(Writer writer, XmlFriendlyReplacer replacer)
public PrettyPrintWriter(Writer writer, int mode)
public PrettyPrintWriter(Writer writer)
public void startNode(String name)
public void startNode(String name, Class clazz)
startNode
in interface ExtendedHierarchicalStreamWriter
startNode
in class AbstractXmlWriter
public void setValue(String text)
HierarchicalStreamWriter
protected void writeAttributeValue(QuickWriter writer, String text)
protected void writeText(QuickWriter writer, String text)
public void endNode()
protected void endOfLine()
public void flush()
HierarchicalStreamWriter
public void close()
HierarchicalStreamWriter
protected String getNewLine()
Copyright © 2016 Internet2. All rights reserved.