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

Modifier and Type	Field and Description
private boolean	namespaceRepairingMode
private final XMLStreamWriter	out
private final QNameMap	qnameMap
private int	tagDepth
private final boolean	writeEnclosingDocument

Constructor Summary

Access	Constructor and Description
public	StaxWriter(QNameMap qnameMap, XMLStreamWriter out)
public	StaxWriter(QNameMap is the mapper of Java class names to QNames qnameMap, XMLStreamWriter the stream to output to out, NameCoder the xml-friendly replacer to escape Java names nameCoder) Allows a StaxWriter to be created for partial XML output
public	StaxWriter(QNameMap is the mapper of Java class names to QNames qnameMap, XMLStreamWriter the stream to output to out, boolean a flag to indicate whether or not the start/end document events should be written writeEnclosingDocument, boolean a flag to enable StAX' namespace repairing mode namespaceRepairingMode, NameCoder the xml-friendly replacer to escape Java names nameCoder) Allows a StaxWriter to be created for partial XML output
public	StaxWriter(QNameMap is the mapper of Java class names to QNames qnameMap, XMLStreamWriter the stream to output to out, boolean a flag to indicate whether or not the start/end document events should be written writeEnclosingDocument, boolean namespaceRepairingMode) Allows a StaxWriter to be created for partial XML output
public	StaxWriter(QNameMap is the mapper of Java class names to QNames qnameMap, XMLStreamWriter the stream to output to out, boolean a flag to indicate whether or not the start/end document events should be written writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer the xml-friendly replacer to escape Java names replacer) Deprecated As of 1.4 use `StaxWriter#StaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder)` instead Allows a StaxWriter to be created for partial XML output

Method Summary

Modifier and Type	Method and Description
public void	addAttribute(String name, String value) Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.addAttribute.
public void	close() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.close. Call this method when you're finished with me
public void	endNode() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.endNode.
public void	flush() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.flush. Flush the writer, if necessary.
protected QNameMap	getQNameMap()
protected XMLStreamWriter	getXMLStreamWriter()
public boolean	isNamespaceRepairingMode() Is StAX namespace repairing mode on or off?
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.

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

Field Detail

namespaceRepairingMode	back to summary
private boolean namespaceRepairingMode

out	back to summary
private final XMLStreamWriter out

qnameMap	back to summary
private final QNameMap qnameMap

tagDepth	back to summary
private int tagDepth

writeEnclosingDocument	back to summary
private final boolean writeEnclosingDocument

Constructor Detail

StaxWriter	back to summary
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out) throws XMLStreamException

StaxWriter	back to summary
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, NameCoder nameCoder) throws XMLStreamException Allows a StaxWriter to be created for partial XML output Parameters qnameMap:QNameMap is the mapper of Java class names to QNames out:XMLStreamWriter the stream to output to nameCoder:NameCoder the xml-friendly replacer to escape Java names Exceptions XMLStreamException: if the events could not be written to the output Since 1.4

StaxWriter

back to summary

public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, NameCoder nameCoder) throws XMLStreamException

Allows a StaxWriter to be created for partial XML output

Parameters

qnameMap:QNameMap: is the mapper of Java class names to QNames
out:XMLStreamWriter: the stream to output to
nameCoder:NameCoder: the xml-friendly replacer to escape Java names

Exceptions

XMLStreamException:: if the events could not be written to the output

Since

1.4

StaxWriter	back to summary
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:QNameMap is the mapper of Java class names to QNames out:XMLStreamWriter the stream to output to writeEnclosingDocument:boolean a flag to indicate whether or not the start/end document events should be written namespaceRepairingMode:boolean a flag to enable StAX' namespace repairing mode nameCoder:NameCoder the xml-friendly replacer to escape Java names Exceptions XMLStreamException: if the events could not be written to the output Since 1.4

StaxWriter

back to summary

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:QNameMap: is the mapper of Java class names to QNames
out:XMLStreamWriter: the stream to output to
writeEnclosingDocument:boolean: a flag to indicate whether or not the start/end document events should be written
namespaceRepairingMode:boolean: a flag to enable StAX' namespace repairing mode
nameCoder:NameCoder: the xml-friendly replacer to escape Java names

Exceptions

XMLStreamException:: if the events could not be written to the output

Since

1.4

StaxWriter	back to summary
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode) throws XMLStreamException Allows a StaxWriter to be created for partial XML output Parameters qnameMap:QNameMap is the mapper of Java class names to QNames out:XMLStreamWriter the stream to output to writeEnclosingDocument:boolean a flag to indicate whether or not the start/end document events should be written Exceptions XMLStreamException: if the events could not be written to the output

StaxWriter

back to summary

public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode) throws XMLStreamException

Allows a StaxWriter to be created for partial XML output

Parameters

qnameMap:QNameMap: is the mapper of Java class names to QNames
out:XMLStreamWriter: the stream to output to
writeEnclosingDocument:boolean: a flag to indicate whether or not the start/end document events should be written

Exceptions

XMLStreamException:: if the events could not be written to the output

StaxWriter back to summary

StaxWriter	back to summary
public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer replacer) throws XMLStreamException Deprecated As of 1.4 use `StaxWriter#StaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder)` instead Allows a StaxWriter to be created for partial XML output Parameters qnameMap:QNameMap is the mapper of Java class names to QNames out:XMLStreamWriter the stream to output to writeEnclosingDocument:boolean a flag to indicate whether or not the start/end document events should be written replacer:XmlFriendlyReplacer the xml-friendly replacer to escape Java names Exceptions XMLStreamException: if the events could not be written to the output Since 1.2

public StaxWriter(QNameMap qnameMap, XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer replacer) throws XMLStreamException

Deprecated

As of 1.4 use StaxWriter#StaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder) instead

Allows a StaxWriter to be created for partial XML output

Parameters

qnameMap:QNameMap: is the mapper of Java class names to QNames
out:XMLStreamWriter: the stream to output to
writeEnclosingDocument:boolean: a flag to indicate whether or not the start/end document events should be written
replacer:XmlFriendlyReplacer: the xml-friendly replacer to escape Java names

Exceptions

XMLStreamException:: if the events could not be written to the output

Since

1.2

Method Detail

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

close	back to summary
public void close() Implements com.thoughtworks.xstream.io.HierarchicalStreamWriter.close. Call this method when you're finished with me

back to summary

public void close()

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

Call this method when you're finished with me

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

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.

getQNameMap	back to summary
protected QNameMap getQNameMap()

getXMLStreamWriter	back to summary
protected XMLStreamWriter getXMLStreamWriter()

isNamespaceRepairingMode	back to summary
public boolean isNamespaceRepairingMode() Is StAX namespace repairing mode on or off?

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.

public Class StaxWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail