Package com.thoughtworks.xstream.io.xml
Class StaxWriter
java.lang.Object
com.thoughtworks.xstream.io.AbstractWriter
com.thoughtworks.xstream.io.xml.AbstractXmlWriter
com.thoughtworks.xstream.io.xml.StaxWriter
- All Implemented Interfaces:
ExtendedHierarchicalStreamWriter
,HierarchicalStreamWriter
,XmlFriendlyWriter
A stream writing that outputs to a StAX stream writer
- Version:
- $Revision$
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private final XMLStreamWriter
private final QNameMap
private int
private final boolean
-
Constructor Summary
ConstructorsConstructorDescriptionStaxWriter
(QNameMap qnameMap, XMLStreamWriter out) StaxWriter
(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode) Allows a StaxWriter to be created for partial XML outputStaxWriter
(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, NameCoder nameCoder) Allows a StaxWriter to be created for partial XML outputStaxWriter
(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer replacer) Deprecated.StaxWriter
(QNameMap qnameMap, XMLStreamWriter out, NameCoder nameCoder) Allows a StaxWriter to be created for partial XML output -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(String name, String value) void
close()
Call this method when you're finished with mevoid
endNode()
void
flush()
Flush the writer, if necessary.protected QNameMap
protected XMLStreamWriter
boolean
Is StAX namespace repairing mode on or off?void
Write the value (text content) of the current node.void
Methods inherited from class com.thoughtworks.xstream.io.xml.AbstractXmlWriter
escapeXmlName
Methods inherited from class com.thoughtworks.xstream.io.AbstractWriter
encodeAttribute, encodeNode, startNode, underlyingWriter
-
Field Details
-
qnameMap
-
out
-
writeEnclosingDocument
private final boolean writeEnclosingDocument -
namespaceRepairingMode
private boolean namespaceRepairingMode -
tagDepth
private int tagDepth
-
-
Constructor Details
-
StaxWriter
- Throws:
XMLStreamException
-
StaxWriter
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, NameCoder nameCoder) throws XMLStreamException Allows a StaxWriter to be created for partial XML output- Parameters:
qnameMap
- is the mapper of Java class names to QNamesout
- the stream to output tonameCoder
- the xml-friendly replacer to escape Java names- Throws:
XMLStreamException
- if the events could not be written to the output- Since:
- 1.4
-
StaxWriter
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, NameCoder nameCoder) throws XMLStreamException Allows a StaxWriter to be created for partial XML output- Parameters:
qnameMap
- is the mapper of Java class names to QNamesout
- the stream to output towriteEnclosingDocument
- a flag to indicate whether or not the start/end document events should be writtennamespaceRepairingMode
- a flag to enable StAX' namespace repairing modenameCoder
- the xml-friendly replacer to escape Java names- Throws:
XMLStreamException
- if the events could not be written to the output- Since:
- 1.4
-
StaxWriter
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode) throws XMLStreamException Allows a StaxWriter to be created for partial XML output- Parameters:
qnameMap
- is the mapper of Java class names to QNamesout
- the stream to output towriteEnclosingDocument
- a flag to indicate whether or not the start/end document events should be written- Throws:
XMLStreamException
- if the events could not be written to the output
-
StaxWriter
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer replacer) throws XMLStreamException Deprecated.As of 1.4 useStaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder)
insteadAllows a StaxWriter to be created for partial XML output- Parameters:
qnameMap
- is the mapper of Java class names to QNamesout
- the stream to output towriteEnclosingDocument
- a flag to indicate whether or not the start/end document events should be writtenreplacer
- the xml-friendly replacer to escape Java names- Throws:
XMLStreamException
- if the events could not be written to the output- Since:
- 1.2
-
-
Method Details
-
flush
public void flush()Description copied from interface:HierarchicalStreamWriter
Flush the writer, if necessary. -
close
public void close()Call this method when you're finished with me -
addAttribute
-
endNode
public void endNode() -
setValue
Description copied from interface:HierarchicalStreamWriter
Write the value (text content) of the current node. -
startNode
-
isNamespaceRepairingMode
public boolean isNamespaceRepairingMode()Is StAX namespace repairing mode on or off? -
getQNameMap
-
getXMLStreamWriter
-
StaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder)
instead