/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html

http://prototipomemoria.googlecode.com/ · 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>
  8. AbstractDocumentWriter (XStream Core 1.4.1 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2011-08-11">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="AbstractDocumentWriter (XStream Core 1.4.1 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDocumentWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="AbstractDocumentWriter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. com.thoughtworks.xstream.io.xml</FONT>
  82. <BR>
  83. Class AbstractDocumentWriter</H2>
  84. <PRE>
  85. <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>
  86. <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>
  87. <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>
  88. <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.xml.AbstractDocumentWriter</B>
  89. </PRE>
  90. <DL>
  91. <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>
  92. </DL>
  93. <DL>
  94. <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>
  95. </DL>
  96. <HR>
  97. <DL>
  98. <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>
  99. </PRE>
  100. <P>
  101. A generic <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io"><CODE>HierarchicalStreamWriter</CODE></A> for DOM writer
  102. implementations. The implementation manages a list of top level DOM nodes. Every time the
  103. last node is closed on the node stack, the next started node is added to the list. This list
  104. can be retrieved using the <A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html#getTopLevelNodes()"><CODE>DocumentWriter.getTopLevelNodes()</CODE></A> method.
  105. <P>
  106. <P>
  107. <DL>
  108. <DT><B>Since:</B></DT>
  109. <DD>1.2.1</DD>
  110. <DT><B>Author:</B></DT>
  111. <DD>Laurent Bihanic, J&ouml;rg Schaible</DD>
  112. </DL>
  113. <HR>
  114. <P>
  115. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  116. <A NAME="constructor_summary"><!-- --></A>
  117. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  118. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  119. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  120. <B>Constructor Summary</B></FONT></TH>
  121. </TR>
  122. <TR BGCOLOR="white" CLASS="TableRowColor">
  123. <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>&nbsp;container,
  124. <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A>&nbsp;nameCoder)</CODE>
  125. <BR>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an AbstractDocumentWriter.</TD>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <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>&nbsp;container,
  130. <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A>&nbsp;replacer)</CODE>
  131. <BR>
  132. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>As of 1.4 use
  133. <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>
  134. instead.</I></TD>
  135. </TR>
  136. </TABLE>
  137. &nbsp;
  138. <!-- ========== METHOD SUMMARY =========== -->
  139. <A NAME="method_summary"><!-- --></A>
  140. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  141. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  142. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  143. <B>Method Summary</B></FONT></TH>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  147. <CODE>&nbsp;void</CODE></FONT></TD>
  148. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#close()">close</A></B>()</CODE>
  149. <BR>
  150. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the writer, if necessary.</TD>
  151. </TR>
  152. <TR BGCOLOR="white" CLASS="TableRowColor">
  153. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  154. <CODE>protected abstract &nbsp;<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>
  155. <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>&nbsp;name)</CODE>
  156. <BR>
  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a node.</TD>
  158. </TR>
  159. <TR BGCOLOR="white" CLASS="TableRowColor">
  160. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  161. <CODE>&nbsp;void</CODE></FONT></TD>
  162. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#endNode()">endNode</A></B>()</CODE>
  163. <BR>
  164. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  165. </TR>
  166. <TR BGCOLOR="white" CLASS="TableRowColor">
  167. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  168. <CODE>&nbsp;void</CODE></FONT></TD>
  169. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#endNodeInternally()">endNodeInternally</A></B>()</CODE>
  170. <BR>
  171. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called when a node ends.</TD>
  172. </TR>
  173. <TR BGCOLOR="white" CLASS="TableRowColor">
  174. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  175. <CODE>&nbsp;void</CODE></FONT></TD>
  176. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#flush()">flush</A></B>()</CODE>
  177. <BR>
  178. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flush the writer, if necessary.</TD>
  179. </TR>
  180. <TR BGCOLOR="white" CLASS="TableRowColor">
  181. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  182. <CODE>protected &nbsp;<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>
  183. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#getCurrent()">getCurrent</A></B>()</CODE>
  184. <BR>
  185. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  186. </TR>
  187. <TR BGCOLOR="white" CLASS="TableRowColor">
  188. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  189. <CODE>&nbsp;<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>
  190. <TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html#getTopLevelNodes()">getTopLevelNodes</A></B>()</CODE>
  191. <BR>
  192. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
  193. </TR>
  194. <TR BGCOLOR="white" CLASS="TableRowColor">
  195. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  196. <CODE>&nbsp;void</CODE></FONT></TD>
  197. <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>&nbsp;name)</CODE>
  198. <BR>
  199. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  200. </TR>
  201. </TABLE>
  202. &nbsp;<A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractXmlWriter"><!-- --></A>
  203. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  204. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  205. <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>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlWriter.html#escapeXmlName(java.lang.String)">escapeXmlName</A></CODE></TD>
  209. </TR>
  210. </TABLE>
  211. &nbsp;<A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.AbstractWriter"><!-- --></A>
  212. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  213. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  214. <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>
  215. </TR>
  216. <TR BGCOLOR="white" CLASS="TableRowColor">
  217. <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>
  218. </TR>
  219. </TABLE>
  220. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  221. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  222. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  223. <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>
  224. </TR>
  225. <TR BGCOLOR="white" CLASS="TableRowColor">
  226. <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>
  227. </TR>
  228. </TABLE>
  229. &nbsp;<A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.HierarchicalStreamWriter"><!-- --></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 interface com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></B></TH>
  233. </TR>
  234. <TR BGCOLOR="white" CLASS="TableRowColor">
  235. <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>
  236. </TR>
  237. </TABLE>
  238. &nbsp;
  239. <P>
  240. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  241. <A NAME="constructor_detail"><!-- --></A>
  242. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  243. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  244. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  245. <B>Constructor Detail</B></FONT></TH>
  246. </TR>
  247. </TABLE>
  248. <A NAME="AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3>
  249. AbstractDocumentWriter</H3>
  250. <PRE>
  251. public <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>&nbsp;container,
  252. <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A>&nbsp;nameCoder)</PRE>
  253. <DL>
  254. <DD>Constructs an AbstractDocumentWriter.
  255. <P>
  256. <DL>
  257. <DT><B>Parameters:</B><DD><CODE>container</CODE> - the top level container for the nodes to create (may be
  258. <code>null</code>)<DD><CODE>nameCoder</CODE> - the object that creates XML-friendly names<DT><B>Since:</B></DT>
  259. <DD>1.4</DD>
  260. </DL>
  261. </DL>
  262. <HR>
  263. <A NAME="AbstractDocumentWriter(java.lang.Object, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)"><!-- --></A><H3>
  264. AbstractDocumentWriter</H3>
  265. <PRE>
  266. public <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>&nbsp;container,
  267. <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A>&nbsp;replacer)</PRE>
  268. <DL>
  269. <DD><B>Deprecated.</B>&nbsp;<I>As of 1.4 use
  270. <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>
  271. instead.</I>
  272. <P>
  273. <DD>Constructs an AbstractDocumentWriter.
  274. <P>
  275. <DL>
  276. <DT><B>Parameters:</B><DD><CODE>container</CODE> - the top level container for the nodes to create (may be
  277. <code>null</code>)<DD><CODE>replacer</CODE> - the object that creates XML-friendly names<DT><B>Since:</B></DT>
  278. <DD>1.2.1</DD>
  279. </DL>
  280. </DL>
  281. <!-- ============ METHOD DETAIL ========== -->
  282. <A NAME="method_detail"><!-- --></A>
  283. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  284. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  285. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  286. <B>Method Detail</B></FONT></TH>
  287. </TR>
  288. </TABLE>
  289. <A NAME="startNode(java.lang.String)"><!-- --></A><H3>
  290. startNode</H3>
  291. <PRE>
  292. public 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>&nbsp;name)</PRE>
  293. <DL>
  294. <DD><DL>
  295. <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>
  296. </DD>
  297. <DD><DL>
  298. </DL>
  299. </DD>
  300. </DL>
  301. <HR>
  302. <A NAME="createNode(java.lang.String)"><!-- --></A><H3>
  303. createNode</H3>
  304. <PRE>
  305. 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> <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>&nbsp;name)</PRE>
  306. <DL>
  307. <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>
  308. returns <code>null</code> the node is a top level node.
  309. <P>
  310. <DD><DL>
  311. </DL>
  312. </DD>
  313. <DD><DL>
  314. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the node name
  315. <DT><B>Returns:</B><DD>the new node<DT><B>Since:</B></DT>
  316. <DD>1.2.1</DD>
  317. </DL>
  318. </DD>
  319. </DL>
  320. <HR>
  321. <A NAME="endNode()"><!-- --></A><H3>
  322. endNode</H3>
  323. <PRE>
  324. public final void <B>endNode</B>()</PRE>
  325. <DL>
  326. <DD><DL>
  327. <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>
  328. </DD>
  329. <DD><DL>
  330. </DL>
  331. </DD>
  332. </DL>
  333. <HR>
  334. <A NAME="endNodeInternally()"><!-- --></A><H3>
  335. endNodeInternally</H3>
  336. <PRE>
  337. public void <B>endNodeInternally</B>()</PRE>
  338. <DL>
  339. <DD>Called when a node ends. Hook for derived implementations.
  340. <P>
  341. <DD><DL>
  342. </DL>
  343. </DD>
  344. <DD><DL>
  345. <DT><B>Since:</B></DT>
  346. <DD>1.2.1</DD>
  347. </DL>
  348. </DD>
  349. </DL>
  350. <HR>
  351. <A NAME="getCurrent()"><!-- --></A><H3>
  352. getCurrent</H3>
  353. <PRE>
  354. protected 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>
  355. <DL>
  356. <DD><DL>
  357. </DL>
  358. </DD>
  359. <DD><DL>
  360. <DT><B>Since:</B></DT>
  361. <DD>1.2.1</DD>
  362. </DL>
  363. </DD>
  364. </DL>
  365. <HR>
  366. <A NAME="getTopLevelNodes()"><!-- --></A><H3>
  367. getTopLevelNodes</H3>
  368. <PRE>
  369. public <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>
  370. <DL>
  371. <DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/DocumentWriter.html#getTopLevelNodes()">DocumentWriter</A></CODE></B></DD>
  372. <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
  373. only contain a single element. Additional elements can only occur, if
  374. <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#startNode(java.lang.String)"><CODE>HierarchicalStreamWriter.startNode(String)</CODE></A> of the implementing
  375. <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
  376. a situation occurs calling
  377. <A HREF="../../../../../com/thoughtworks/xstream/XStream.html#marshal(java.lang.Object, com.thoughtworks.xstream.io.HierarchicalStreamWriter)"><CODE>XStream.marshal(Object, HierarchicalStreamWriter)</CODE></A>
  378. multiple times directly.
  379. <P>
  380. <DD><DL>
  381. <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>
  382. </DD>
  383. <DD><DL>
  384. <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>
  385. </DD>
  386. </DL>
  387. <HR>
  388. <A NAME="flush()"><!-- --></A><H3>
  389. flush</H3>
  390. <PRE>
  391. public void <B>flush</B>()</PRE>
  392. <DL>
  393. <DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#flush()">HierarchicalStreamWriter</A></CODE></B></DD>
  394. <DD>Flush the writer, if necessary.
  395. <P>
  396. <DD><DL>
  397. <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>
  398. </DD>
  399. <DD><DL>
  400. </DL>
  401. </DD>
  402. </DL>
  403. <HR>
  404. <A NAME="close()"><!-- --></A><H3>
  405. close</H3>
  406. <PRE>
  407. public void <B>close</B>()</PRE>
  408. <DL>
  409. <DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#close()">HierarchicalStreamWriter</A></CODE></B></DD>
  410. <DD>Close the writer, if necessary.
  411. <P>
  412. <DD><DL>
  413. <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>
  414. </DD>
  415. <DD><DL>
  416. </DL>
  417. </DD>
  418. </DL>
  419. <!-- ========= END OF CLASS DATA ========= -->
  420. <HR>
  421. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  422. <A NAME="navbar_bottom"><!-- --></A>
  423. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  424. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  425. <TR>
  426. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  427. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  428. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  429. <TR ALIGN="center" VALIGN="top">
  430. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  431. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  432. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  433. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDocumentWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  434. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  435. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  436. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  437. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  438. </TR>
  439. </TABLE>
  440. </TD>
  441. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  442. </EM>
  443. </TD>
  444. </TR>
  445. <TR>
  446. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  447. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A>&nbsp;
  448. &nbsp;<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD>
  449. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  450. <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html" target="_top"><B>FRAMES</B></A> &nbsp;
  451. &nbsp;<A HREF="AbstractDocumentWriter.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  452. &nbsp;<SCRIPT type="text/javascript">
  453. <!--
  454. if(window==top) {
  455. document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  456. }
  457. //-->
  458. </SCRIPT>
  459. <NOSCRIPT>
  460. <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
  461. </NOSCRIPT>
  462. </FONT></TD>
  463. </TR>
  464. <TR>
  465. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  466. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  467. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  468. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  469. </TR>
  470. </TABLE>
  471. <A NAME="skip-navbar_bottom"></A>
  472. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  473. <HR>
  474. Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
  475. </BODY>
  476. </HTML>