/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html
HTML | 524 lines | 454 code | 48 blank | 22 comment | 0 complexity | 00a1f48f68b24ded3a319bb012409f39 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> 8AbstractDocumentWriter (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="AbstractDocumentWriter (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/AbstractDocumentWriter.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/AbstractDocumentReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.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/AbstractDocumentWriter.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="AbstractDocumentWriter.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 AbstractDocumentWriter</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.AbstractDocumentWriter</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/DocumentWriter.html" title="interface in com.thoughtworks.xstream.io.xml">DocumentWriter</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/xml/Dom4JWriter.html" title="class in com.thoughtworks.xstream.io.xml">Dom4JWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/DomWriter.html" title="class in com.thoughtworks.xstream.io.xml">DomWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/JDomWriter.html" title="class in com.thoughtworks.xstream.io.xml">JDomWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XomWriter.html" title="class in com.thoughtworks.xstream.io.xml">XomWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppDomWriter.html" title="class in com.thoughtworks.xstream.io.xml">XppDomWriter</A></DD> 106</DL> 107<HR> 108<DL> 109<DT><PRE>public abstract class <B>AbstractDocumentWriter</B><DT>extends <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlWriter</A><DT>implements <A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html" title="interface in com.thoughtworks.xstream.io.xml">DocumentWriter</A></DL> 110</PRE> 111 112<P> 113A generic <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io"><CODE>HierarchicalStreamWriter</CODE></A> for DOM writer 114 implementations. The implementation manages a list of top level DOM nodes. Every time the 115 last node is closed on the node stack, the next started node is added to the list. This list 116 can be retrieved using the <A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html#getTopLevelNodes()"><CODE>DocumentWriter.getTopLevelNodes()</CODE></A> method. 117<P> 118 119<P> 120<DL> 121<DT><B>Since:</B></DT> 122 <DD>1.2.1</DD> 123<DT><B>Author:</B></DT> 124 <DD>Laurent Bihanic, Jörg Schaible</DD> 125</DL> 126<HR> 127 128<P> 129 130<!-- ======== CONSTRUCTOR SUMMARY ======== --> 131 132<A NAME="constructor_summary"><!-- --></A> 133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 136<B>Constructor Summary</B></FONT></TH> 137</TR> 138<TR BGCOLOR="white" CLASS="TableRowColor"> 139<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.naming.NameCoder)">AbstractDocumentWriter</A></B>(<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> container, 140 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 141 142<BR> 143 Constructs an AbstractDocumentWriter.</TD> 144</TR> 145<TR BGCOLOR="white" CLASS="TableRowColor"> 146<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)">AbstractDocumentWriter</A></B>(<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> container, 147 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</CODE> 148 149<BR> 150 <B>Deprecated.</B> <I>As of 1.4 use 151 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.naming.NameCoder)"><CODE>AbstractDocumentWriter(Object, NameCoder)</CODE></A> 152 instead.</I></TD> 153</TR> 154</TABLE> 155 156<!-- ========== METHOD SUMMARY =========== --> 157 158<A NAME="method_summary"><!-- --></A> 159<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 160<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 161<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 162<B>Method Summary</B></FONT></TH> 163</TR> 164<TR BGCOLOR="white" CLASS="TableRowColor"> 165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 166<CODE> void</CODE></FONT></TD> 167<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#close()">close</A></B>()</CODE> 168 169<BR> 170 Close the writer, if necessary.</TD> 171</TR> 172<TR BGCOLOR="white" CLASS="TableRowColor"> 173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 174<CODE>protected abstract <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></CODE></FONT></TD> 175<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#createNode(java.lang.String)">createNode</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> 176 177<BR> 178 Create a node.</TD> 179</TR> 180<TR BGCOLOR="white" CLASS="TableRowColor"> 181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 182<CODE> void</CODE></FONT></TD> 183<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#endNode()">endNode</A></B>()</CODE> 184 185<BR> 186 </TD> 187</TR> 188<TR BGCOLOR="white" CLASS="TableRowColor"> 189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 190<CODE> void</CODE></FONT></TD> 191<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#endNodeInternally()">endNodeInternally</A></B>()</CODE> 192 193<BR> 194 Called when a node ends.</TD> 195</TR> 196<TR BGCOLOR="white" CLASS="TableRowColor"> 197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 198<CODE> void</CODE></FONT></TD> 199<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#flush()">flush</A></B>()</CODE> 200 201<BR> 202 Flush the writer, if necessary.</TD> 203</TR> 204<TR BGCOLOR="white" CLASS="TableRowColor"> 205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 206<CODE>protected <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></CODE></FONT></TD> 207<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#getCurrent()">getCurrent</A></B>()</CODE> 208 209<BR> 210 </TD> 211</TR> 212<TR BGCOLOR="white" CLASS="TableRowColor"> 213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 214<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A></CODE></FONT></TD> 215<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#getTopLevelNodes()">getTopLevelNodes</A></B>()</CODE> 216 217<BR> 218 Retrieve a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> with the top elements.</TD> 219</TR> 220<TR BGCOLOR="white" CLASS="TableRowColor"> 221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 222<CODE> void</CODE></FONT></TD> 223<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.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> 224 225<BR> 226 </TD> 227</TR> 228</TABLE> 229 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractXmlWriter"><!-- --></A> 230<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 231<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 232<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> 233</TR> 234<TR BGCOLOR="white" CLASS="TableRowColor"> 235<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html#escapeXmlName(java.lang.String)">escapeXmlName</A></CODE></TD> 236</TR> 237</TABLE> 238 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.AbstractWriter"><!-- --></A> 239<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 240<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 241<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> 242</TR> 243<TR BGCOLOR="white" CLASS="TableRowColor"> 244<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> 245</TR> 246</TABLE> 247 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 248<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 249<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 250<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> 251</TR> 252<TR BGCOLOR="white" CLASS="TableRowColor"> 253<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> 254</TR> 255</TABLE> 256 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.HierarchicalStreamWriter"><!-- --></A> 257<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 258<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 259<TH ALIGN="left"><B>Methods inherited from interface com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></B></TH> 260</TR> 261<TR BGCOLOR="white" CLASS="TableRowColor"> 262<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#addAttribute(java.lang.String, java.lang.String)">addAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#setValue(java.lang.String)">setValue</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#underlyingWriter()">underlyingWriter</A></CODE></TD> 263</TR> 264</TABLE> 265 266<P> 267 268<!-- ========= CONSTRUCTOR DETAIL ======== --> 269 270<A NAME="constructor_detail"><!-- --></A> 271<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 272<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 273<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 274<B>Constructor Detail</B></FONT></TH> 275</TR> 276</TABLE> 277 278<A NAME="AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 279AbstractDocumentWriter</H3> 280<PRE> 281public <B>AbstractDocumentWriter</B>(<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> container, 282 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</PRE> 283<DL> 284<DD>Constructs an AbstractDocumentWriter. 285<P> 286<DL> 287<DT><B>Parameters:</B><DD><CODE>container</CODE> - the top level container for the nodes to create (may be 288 <code>null</code>)<DD><CODE>nameCoder</CODE> - the object that creates XML-friendly names<DT><B>Since:</B></DT> 289 <DD>1.4</DD> 290</DL> 291</DL> 292<HR> 293 294<A NAME="AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)"><!-- --></A><H3> 295AbstractDocumentWriter</H3> 296<PRE> 297public <B>AbstractDocumentWriter</B>(<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> container, 298 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</PRE> 299<DL> 300<DD><B>Deprecated.</B> <I>As of 1.4 use 301 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.naming.NameCoder)"><CODE>AbstractDocumentWriter(Object, NameCoder)</CODE></A> 302 instead.</I> 303<P> 304<DD>Constructs an AbstractDocumentWriter. 305<P> 306<DL> 307<DT><B>Parameters:</B><DD><CODE>container</CODE> - the top level container for the nodes to create (may be 308 <code>null</code>)<DD><CODE>replacer</CODE> - the object that creates XML-friendly names<DT><B>Since:</B></DT> 309 <DD>1.2.1</DD> 310</DL> 311</DL> 312 313<!-- ============ METHOD DETAIL ========== --> 314 315<A NAME="method_detail"><!-- --></A> 316<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 317<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 318<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 319<B>Method Detail</B></FONT></TH> 320</TR> 321</TABLE> 322 323<A NAME="startNode(java.lang.String)"><!-- --></A><H3> 324startNode</H3> 325<PRE> 326public final 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> 327<DL> 328<DD><DL> 329<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#startNode(java.lang.String)">startNode</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></CODE></DL> 330</DD> 331<DD><DL> 332</DL> 333</DD> 334</DL> 335<HR> 336 337<A NAME="createNode(java.lang.String)"><!-- --></A><H3> 338createNode</H3> 339<PRE> 340protected abstract <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>createNode</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> 341<DL> 342<DD>Create a node. The provided node name is not yet XML friendly. If <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#getCurrent()"><CODE>getCurrent()</CODE></A> 343 returns <code>null</code> the node is a top level node. 344<P> 345<DD><DL> 346</DL> 347</DD> 348<DD><DL> 349<DT><B>Parameters:</B><DD><CODE>name</CODE> - the node name 350<DT><B>Returns:</B><DD>the new node<DT><B>Since:</B></DT> 351 <DD>1.2.1</DD> 352</DL> 353</DD> 354</DL> 355<HR> 356 357<A NAME="endNode()"><!-- --></A><H3> 358endNode</H3> 359<PRE> 360public final void <B>endNode</B>()</PRE> 361<DL> 362<DD><DL> 363<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#endNode()">endNode</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></CODE></DL> 364</DD> 365<DD><DL> 366</DL> 367</DD> 368</DL> 369<HR> 370 371<A NAME="endNodeInternally()"><!-- --></A><H3> 372endNodeInternally</H3> 373<PRE> 374public void <B>endNodeInternally</B>()</PRE> 375<DL> 376<DD>Called when a node ends. Hook for derived implementations. 377<P> 378<DD><DL> 379</DL> 380</DD> 381<DD><DL> 382<DT><B>Since:</B></DT> 383 <DD>1.2.1</DD> 384</DL> 385</DD> 386</DL> 387<HR> 388 389<A NAME="getCurrent()"><!-- --></A><H3> 390getCurrent</H3> 391<PRE> 392protected final <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>getCurrent</B>()</PRE> 393<DL> 394<DD><DL> 395</DL> 396</DD> 397<DD><DL> 398<DT><B>Since:</B></DT> 399 <DD>1.2.1</DD> 400</DL> 401</DD> 402</DL> 403<HR> 404 405<A NAME="getTopLevelNodes()"><!-- --></A><H3> 406getTopLevelNodes</H3> 407<PRE> 408public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <B>getTopLevelNodes</B>()</PRE> 409<DL> 410<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html#getTopLevelNodes()">DocumentWriter</A></CODE></B></DD> 411<DD>Retrieve a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> with the top elements. In the standard use case this list will 412 only contain a single element. Additional elements can only occur, if 413 <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#startNode(java.lang.String)"><CODE>HierarchicalStreamWriter.startNode(String)</CODE></A> of the implementing 414 <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io"><CODE>HierarchicalStreamWriter</CODE></A> was called multiple times with an empty node stack. Such 415 a situation occurs calling 416 <A HREF="../../../../../com/thoughtworks/xstream/XStream.html#marshal(java.lang.Object, com.thoughtworks.xstream.io.HierarchicalStreamWriter)"><CODE>XStream.marshal(Object, HierarchicalStreamWriter)</CODE></A> 417 multiple times directly. 418<P> 419<DD><DL> 420<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html#getTopLevelNodes()">getTopLevelNodes</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html" title="interface in com.thoughtworks.xstream.io.xml">DocumentWriter</A></CODE></DL> 421</DD> 422<DD><DL> 423 424<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> with top nodes</DL> 425</DD> 426</DL> 427<HR> 428 429<A NAME="flush()"><!-- --></A><H3> 430flush</H3> 431<PRE> 432public void <B>flush</B>()</PRE> 433<DL> 434<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#flush()">HierarchicalStreamWriter</A></CODE></B></DD> 435<DD>Flush the writer, if necessary. 436<P> 437<DD><DL> 438<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#flush()">flush</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></CODE></DL> 439</DD> 440<DD><DL> 441</DL> 442</DD> 443</DL> 444<HR> 445 446<A NAME="close()"><!-- --></A><H3> 447close</H3> 448<PRE> 449public void <B>close</B>()</PRE> 450<DL> 451<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#close()">HierarchicalStreamWriter</A></CODE></B></DD> 452<DD>Close the writer, if necessary. 453<P> 454<DD><DL> 455<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></CODE></DL> 456</DD> 457<DD><DL> 458</DL> 459</DD> 460</DL> 461<!-- ========= END OF CLASS DATA ========= --> 462<HR> 463 464 465<!-- ======= START OF BOTTOM NAVBAR ====== --> 466<A NAME="navbar_bottom"><!-- --></A> 467<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 468<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 469<TR> 470<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 471<A NAME="navbar_bottom_firstrow"><!-- --></A> 472<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 473 <TR ALIGN="center" VALIGN="top"> 474 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 475 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 476 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 477 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDocumentWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 478 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 479 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 480 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 481 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 482 </TR> 483</TABLE> 484</TD> 485<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 486</EM> 487</TD> 488</TR> 489 490<TR> 491<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 492 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 493 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 494<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 495 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html" target="_top"><B>FRAMES</B></A> 496 <A HREF="AbstractDocumentWriter.html" target="_top"><B>NO FRAMES</B></A> 497 <SCRIPT type="text/javascript"> 498 <!-- 499 if(window==top) { 500 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 501 } 502 //--> 503</SCRIPT> 504<NOSCRIPT> 505 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 506</NOSCRIPT> 507 508 509</FONT></TD> 510</TR> 511<TR> 512<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 513 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 514<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 515DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 516</TR> 517</TABLE> 518<A NAME="skip-navbar_bottom"></A> 519<!-- ======== END OF BOTTOM NAVBAR ======= --> 520 521<HR> 522Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 523</BODY> 524</HTML>