|
||||||||||
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.StaxWriter
public class StaxWriter
A stream writing that outputs to a StAX stream writer
Constructor Summary | |
---|---|
StaxWriter(QNameMap qnameMap,
javax.xml.stream.XMLStreamWriter out)
|
|
StaxWriter(QNameMap qnameMap,
javax.xml.stream.XMLStreamWriter out,
boolean writeEnclosingDocument,
boolean namespaceRepairingMode)
Allows a StaxWriter to be created for partial XML output |
|
StaxWriter(QNameMap qnameMap,
javax.xml.stream.XMLStreamWriter out,
boolean writeEnclosingDocument,
boolean namespaceRepairingMode,
XmlFriendlyReplacer replacer)
Allows a StaxWriter to be created for partial XML output |
Method Summary | |
---|---|
void |
addAttribute(java.lang.String name,
java.lang.String value)
|
void |
close()
Call this method when you're finished with me |
void |
endNode()
|
void |
flush()
Flush the writer, if necessary. |
boolean |
isNamespaceRepairingMode()
Is StAX namespace repairing mode on or off? |
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. |
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 StaxWriter(QNameMap qnameMap, javax.xml.stream.XMLStreamWriter out) throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
public StaxWriter(QNameMap qnameMap, javax.xml.stream.XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode) throws javax.xml.stream.XMLStreamException
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
javax.xml.stream.XMLStreamException
- if the events could not be written to the outputpublic StaxWriter(QNameMap qnameMap, javax.xml.stream.XMLStreamWriter out, boolean writeEnclosingDocument, boolean namespaceRepairingMode, XmlFriendlyReplacer replacer) throws javax.xml.stream.XMLStreamException
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
javax.xml.stream.XMLStreamException
- if the events could not be written to the outputMethod Detail |
---|
public void flush()
HierarchicalStreamWriter
public void close()
public void addAttribute(java.lang.String name, java.lang.String value)
public void endNode()
public void setValue(java.lang.String text)
HierarchicalStreamWriter
public void startNode(java.lang.String name)
public void startNode(java.lang.String name, java.lang.Class clazz)
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.
public boolean isNamespaceRepairingMode()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |