/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/StaxWriter.html
HTML | 578 lines | 500 code | 56 blank | 22 comment | 0 complexity | 98ade3894055d35f9fe163b4a5daf612 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:24 CEST 2011 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8StaxWriter (XStream Core 1.4.1 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2011-08-11"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="StaxWriter (XStream Core 1.4.1 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StaxWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/StaxWriter.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="StaxWriter.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.thoughtworks.xstream.io.xml</FONT> 93<BR> 94Class StaxWriter</H2> 95<PRE> 96<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io">com.thoughtworks.xstream.io.AbstractWriter</A> 98 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html" title="class in com.thoughtworks.xstream.io.xml">com.thoughtworks.xstream.io.xml.AbstractXmlWriter</A> 99 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.xml.StaxWriter</B> 100</PRE> 101<DL> 102<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/io/ExtendedHierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">ExtendedHierarchicalStreamWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyWriter.html" title="interface in com.thoughtworks.xstream.io.xml">XmlFriendlyWriter</A></DD> 103</DL> 104<DL> 105<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/io/json/JettisonStaxWriter.html" title="class in com.thoughtworks.xstream.io.json">JettisonStaxWriter</A></DD> 106</DL> 107<HR> 108<DL> 109<DT><PRE>public class <B>StaxWriter</B><DT>extends <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlWriter</A></DL> 110</PRE> 111 112<P> 113A stream writing that outputs to a StAX stream writer 114<P> 115 116<P> 117<DL> 118<DT><B>Version:</B></DT> 119 <DD>$Revision: 1861 $</DD> 120<DT><B>Author:</B></DT> 121 <DD>James Strachan</DD> 122</DL> 123<HR> 124 125<P> 126 127<!-- ======== CONSTRUCTOR SUMMARY ======== --> 128 129<A NAME="constructor_summary"><!-- --></A> 130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 133<B>Constructor Summary</B></FONT></TH> 134</TR> 135<TR BGCOLOR="white" CLASS="TableRowColor"> 136<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter)">StaxWriter</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 137 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out)</CODE> 138 139<BR> 140 </TD> 141</TR> 142<TR BGCOLOR="white" CLASS="TableRowColor"> 143<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean)">StaxWriter</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 144 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 145 boolean writeEnclosingDocument, 146 boolean namespaceRepairingMode)</CODE> 147 148<BR> 149 Allows a StaxWriter to be created for partial XML output</TD> 150</TR> 151<TR BGCOLOR="white" CLASS="TableRowColor"> 152<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean, com.thoughtworks.xstream.io.naming.NameCoder)">StaxWriter</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 153 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 154 boolean writeEnclosingDocument, 155 boolean namespaceRepairingMode, 156 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 157 158<BR> 159 Allows a StaxWriter to be created for partial XML output</TD> 160</TR> 161<TR BGCOLOR="white" CLASS="TableRowColor"> 162<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)">StaxWriter</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 163 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 164 boolean writeEnclosingDocument, 165 boolean namespaceRepairingMode, 166 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</CODE> 167 168<BR> 169 <B>Deprecated.</B> <I>As of 1.4 use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean, com.thoughtworks.xstream.io.naming.NameCoder)"><CODE>StaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder)</CODE></A> instead</I></TD> 170</TR> 171<TR BGCOLOR="white" CLASS="TableRowColor"> 172<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, com.thoughtworks.xstream.io.naming.NameCoder)">StaxWriter</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 173 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 174 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 175 176<BR> 177 Allows a StaxWriter to be created for partial XML output</TD> 178</TR> 179</TABLE> 180 181<!-- ========== METHOD SUMMARY =========== --> 182 183<A NAME="method_summary"><!-- --></A> 184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 186<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 187<B>Method Summary</B></FONT></TH> 188</TR> 189<TR BGCOLOR="white" CLASS="TableRowColor"> 190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 191<CODE> void</CODE></FONT></TD> 192<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#addAttribute(java.lang.String, java.lang.String)">addAttribute</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 193 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE> 194 195<BR> 196 </TD> 197</TR> 198<TR BGCOLOR="white" CLASS="TableRowColor"> 199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 200<CODE> void</CODE></FONT></TD> 201<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#close()">close</A></B>()</CODE> 202 203<BR> 204 Call this method when you're finished with me</TD> 205</TR> 206<TR BGCOLOR="white" CLASS="TableRowColor"> 207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 208<CODE> void</CODE></FONT></TD> 209<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#endNode()">endNode</A></B>()</CODE> 210 211<BR> 212 </TD> 213</TR> 214<TR BGCOLOR="white" CLASS="TableRowColor"> 215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 216<CODE> void</CODE></FONT></TD> 217<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#flush()">flush</A></B>()</CODE> 218 219<BR> 220 Flush the writer, if necessary.</TD> 221</TR> 222<TR BGCOLOR="white" CLASS="TableRowColor"> 223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 224<CODE>protected <A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A></CODE></FONT></TD> 225<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#getQNameMap()">getQNameMap</A></B>()</CODE> 226 227<BR> 228 </TD> 229</TR> 230<TR BGCOLOR="white" CLASS="TableRowColor"> 231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 232<CODE>protected <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A></CODE></FONT></TD> 233<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#getXMLStreamWriter()">getXMLStreamWriter</A></B>()</CODE> 234 235<BR> 236 </TD> 237</TR> 238<TR BGCOLOR="white" CLASS="TableRowColor"> 239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 240<CODE> boolean</CODE></FONT></TD> 241<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#isNamespaceRepairingMode()">isNamespaceRepairingMode</A></B>()</CODE> 242 243<BR> 244 Is StAX namespace repairing mode on or off?</TD> 245</TR> 246<TR BGCOLOR="white" CLASS="TableRowColor"> 247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 248<CODE> void</CODE></FONT></TD> 249<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#setValue(java.lang.String)">setValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> text)</CODE> 250 251<BR> 252 Write the value (text content) of the current node.</TD> 253</TR> 254<TR BGCOLOR="white" CLASS="TableRowColor"> 255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 256<CODE> void</CODE></FONT></TD> 257<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#startNode(java.lang.String)">startNode</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> 258 259<BR> 260 </TD> 261</TR> 262</TABLE> 263 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractXmlWriter"><!-- --></A> 264<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 265<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 266<TH ALIGN="left"><B>Methods inherited from class com.thoughtworks.xstream.io.xml.<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlWriter</A></B></TH> 267</TR> 268<TR BGCOLOR="white" CLASS="TableRowColor"> 269<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html#escapeXmlName(java.lang.String)">escapeXmlName</A></CODE></TD> 270</TR> 271</TABLE> 272 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.AbstractWriter"><!-- --></A> 273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 274<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 275<TH ALIGN="left"><B>Methods inherited from class com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io">AbstractWriter</A></B></TH> 276</TR> 277<TR BGCOLOR="white" CLASS="TableRowColor"> 278<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#encodeAttribute(java.lang.String)">encodeAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#encodeNode(java.lang.String)">encodeNode</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#startNode(java.lang.String, java.lang.Class)">startNode</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#underlyingWriter()">underlyingWriter</A></CODE></TD> 279</TR> 280</TABLE> 281 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 282<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 283<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 284<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 285</TR> 286<TR BGCOLOR="white" CLASS="TableRowColor"> 287<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 288</TR> 289</TABLE> 290 291<P> 292 293<!-- ========= CONSTRUCTOR DETAIL ======== --> 294 295<A NAME="constructor_detail"><!-- --></A> 296<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 297<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 298<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 299<B>Constructor Detail</B></FONT></TH> 300</TR> 301</TABLE> 302 303<A NAME="StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter)"><!-- --></A><H3> 304StaxWriter</H3> 305<PRE> 306public <B>StaxWriter</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 307 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out) 308 throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE> 309<DL> 310<DL> 311 312<DT><B>Throws:</B> 313<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE></DL> 314</DL> 315<HR> 316 317<A NAME="StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 318StaxWriter</H3> 319<PRE> 320public <B>StaxWriter</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 321 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 322 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder) 323 throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE> 324<DL> 325<DD>Allows a StaxWriter to be created for partial XML output 326<P> 327<DL> 328<DT><B>Parameters:</B><DD><CODE>qnameMap</CODE> - is the mapper of Java class names to QNames<DD><CODE>out</CODE> - the stream to output to<DD><CODE>nameCoder</CODE> - the xml-friendly replacer to escape Java names 329<DT><B>Throws:</B> 330<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE> - if the events could not be written to the output<DT><B>Since:</B></DT> 331 <DD>1.4</DD> 332</DL> 333</DL> 334<HR> 335 336<A NAME="StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean, com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 337StaxWriter</H3> 338<PRE> 339public <B>StaxWriter</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 340 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 341 boolean writeEnclosingDocument, 342 boolean namespaceRepairingMode, 343 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder) 344 throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE> 345<DL> 346<DD>Allows a StaxWriter to be created for partial XML output 347<P> 348<DL> 349<DT><B>Parameters:</B><DD><CODE>qnameMap</CODE> - is the mapper of Java class names to QNames<DD><CODE>out</CODE> - the stream to output to<DD><CODE>writeEnclosingDocument</CODE> - a flag to indicate whether or not the start/end document events should be written<DD><CODE>namespaceRepairingMode</CODE> - a flag to enable StAX' namespace repairing mode<DD><CODE>nameCoder</CODE> - the xml-friendly replacer to escape Java names 350<DT><B>Throws:</B> 351<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE> - if the events could not be written to the output<DT><B>Since:</B></DT> 352 <DD>1.4</DD> 353</DL> 354</DL> 355<HR> 356 357<A NAME="StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean)"><!-- --></A><H3> 358StaxWriter</H3> 359<PRE> 360public <B>StaxWriter</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 361 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 362 boolean writeEnclosingDocument, 363 boolean namespaceRepairingMode) 364 throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE> 365<DL> 366<DD>Allows a StaxWriter to be created for partial XML output 367<P> 368<DL> 369<DT><B>Parameters:</B><DD><CODE>qnameMap</CODE> - is the mapper of Java class names to QNames<DD><CODE>out</CODE> - the stream to output to<DD><CODE>writeEnclosingDocument</CODE> - a flag to indicate whether or not the start/end document events should be written 370<DT><B>Throws:</B> 371<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE> - if the events could not be written to the output</DL> 372</DL> 373<HR> 374 375<A NAME="StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)"><!-- --></A><H3> 376StaxWriter</H3> 377<PRE> 378public <B>StaxWriter</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> qnameMap, 379 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> out, 380 boolean writeEnclosingDocument, 381 boolean namespaceRepairingMode, 382 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer) 383 throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></PRE> 384<DL> 385<DD><B>Deprecated.</B> <I>As of 1.4 use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html#StaxWriter(com.thoughtworks.xstream.io.xml.QNameMap, javax.xml.stream.XMLStreamWriter, boolean, boolean, com.thoughtworks.xstream.io.naming.NameCoder)"><CODE>StaxWriter(QNameMap, XMLStreamWriter, boolean, boolean, NameCoder)</CODE></A> instead</I> 386<P> 387<DD>Allows a StaxWriter to be created for partial XML output 388<P> 389<DL> 390<DT><B>Parameters:</B><DD><CODE>qnameMap</CODE> - is the mapper of Java class names to QNames<DD><CODE>out</CODE> - the stream to output to<DD><CODE>writeEnclosingDocument</CODE> - a flag to indicate whether or not the start/end document events should be written<DD><CODE>replacer</CODE> - the xml-friendly replacer to escape Java names 391<DT><B>Throws:</B> 392<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</A></CODE> - if the events could not be written to the output<DT><B>Since:</B></DT> 393 <DD>1.2</DD> 394</DL> 395</DL> 396 397<!-- ============ METHOD DETAIL ========== --> 398 399<A NAME="method_detail"><!-- --></A> 400<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 401<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 402<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 403<B>Method Detail</B></FONT></TH> 404</TR> 405</TABLE> 406 407<A NAME="flush()"><!-- --></A><H3> 408flush</H3> 409<PRE> 410public void <B>flush</B>()</PRE> 411<DL> 412<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#flush()">HierarchicalStreamWriter</A></CODE></B></DD> 413<DD>Flush the writer, if necessary. 414<P> 415<DD><DL> 416</DL> 417</DD> 418</DL> 419<HR> 420 421<A NAME="close()"><!-- --></A><H3> 422close</H3> 423<PRE> 424public void <B>close</B>()</PRE> 425<DL> 426<DD>Call this method when you're finished with me 427<P> 428<DD><DL> 429</DL> 430</DD> 431</DL> 432<HR> 433 434<A NAME="addAttribute(java.lang.String, java.lang.String)"><!-- --></A><H3> 435addAttribute</H3> 436<PRE> 437public void <B>addAttribute</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 438 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE> 439<DL> 440<DD><DL> 441</DL> 442</DD> 443</DL> 444<HR> 445 446<A NAME="endNode()"><!-- --></A><H3> 447endNode</H3> 448<PRE> 449public void <B>endNode</B>()</PRE> 450<DL> 451<DD><DL> 452</DL> 453</DD> 454</DL> 455<HR> 456 457<A NAME="setValue(java.lang.String)"><!-- --></A><H3> 458setValue</H3> 459<PRE> 460public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> text)</PRE> 461<DL> 462<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#setValue(java.lang.String)">HierarchicalStreamWriter</A></CODE></B></DD> 463<DD>Write the value (text content) of the current node. 464<P> 465<DD><DL> 466</DL> 467</DD> 468</DL> 469<HR> 470 471<A NAME="startNode(java.lang.String)"><!-- --></A><H3> 472startNode</H3> 473<PRE> 474public void <B>startNode</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> 475<DL> 476<DD><DL> 477</DL> 478</DD> 479</DL> 480<HR> 481 482<A NAME="isNamespaceRepairingMode()"><!-- --></A><H3> 483isNamespaceRepairingMode</H3> 484<PRE> 485public boolean <B>isNamespaceRepairingMode</B>()</PRE> 486<DL> 487<DD>Is StAX namespace repairing mode on or off? 488<P> 489<DD><DL> 490</DL> 491</DD> 492</DL> 493<HR> 494 495<A NAME="getQNameMap()"><!-- --></A><H3> 496getQNameMap</H3> 497<PRE> 498protected <A HREF="../../../../../com/thoughtworks/xstream/io/xml/QNameMap.html" title="class in com.thoughtworks.xstream.io.xml">QNameMap</A> <B>getQNameMap</B>()</PRE> 499<DL> 500<DD><DL> 501</DL> 502</DD> 503</DL> 504<HR> 505 506<A NAME="getXMLStreamWriter()"><!-- --></A><H3> 507getXMLStreamWriter</H3> 508<PRE> 509protected <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamWriter</A> <B>getXMLStreamWriter</B>()</PRE> 510<DL> 511<DD><DL> 512</DL> 513</DD> 514</DL> 515<!-- ========= END OF CLASS DATA ========= --> 516<HR> 517 518 519<!-- ======= START OF BOTTOM NAVBAR ====== --> 520<A NAME="navbar_bottom"><!-- --></A> 521<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 522<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 523<TR> 524<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 525<A NAME="navbar_bottom_firstrow"><!-- --></A> 526<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 527 <TR ALIGN="center" VALIGN="top"> 528 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 529 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 530 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 531 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StaxWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 532 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 533 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 534 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 535 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 536 </TR> 537</TABLE> 538</TD> 539<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 540</EM> 541</TD> 542</TR> 543 544<TR> 545<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 546 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 547 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 548<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 549 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/StaxWriter.html" target="_top"><B>FRAMES</B></A> 550 <A HREF="StaxWriter.html" target="_top"><B>NO FRAMES</B></A> 551 <SCRIPT type="text/javascript"> 552 <!-- 553 if(window==top) { 554 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 555 } 556 //--> 557</SCRIPT> 558<NOSCRIPT> 559 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 560</NOSCRIPT> 561 562 563</FONT></TD> 564</TR> 565<TR> 566<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 567 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 568<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 569DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 570</TR> 571</TABLE> 572<A NAME="skip-navbar_bottom"></A> 573<!-- ======== END OF BOTTOM NAVBAR ======= --> 574 575<HR> 576Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 577</BODY> 578</HTML>