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

http://prototipomemoria.googlecode.com/ · HTML · 531 lines · 458 code · 53 blank · 20 comment · 0 complexity · 26903a1b24fc7007f1e3a844cbee16e1 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:24 CEST 2011 -->
    6. 

  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <TITLE>
    8. 

  8. HierarchicalStreamReader (XStream Core 1.4.1 API)
    9. 

  9. </TITLE>
    10. 

  10. 

  11. <META NAME="date" CONTENT="2011-08-11">
    12. 

  12. 

  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    14. 

  14. 

  15. <SCRIPT type="text/javascript">
    16. 

  16. function windowTitle()
    17. 

  17. {
    18. 

  18.     if (location.href.indexOf('is-external=true') == -1) {
    19. 

  19.         parent.document.title="HierarchicalStreamReader (XStream Core 1.4.1 API)";
    20. 

  20.     }
    21. 

  21. }
    22. 

  22. </SCRIPT>
    23. 

  23. <NOSCRIPT>
    24. 

  24. </NOSCRIPT>
    25. 

  25. 

  26. </HEAD>
    27. 

  27. 

  28. <BODY BGCOLOR="white" onload="windowTitle();">
    29. 

  29. <HR>
    30. 

  30. 

  31. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <A NAME="navbar_top"><!-- --></A>
    34. 

  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    35. 

  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    36. 

  36. <TR>
    37. 

  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    38. 

  38. <A NAME="navbar_top_firstrow"><!-- --></A>
    39. 

  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    40. 

  40.   <TR ALIGN="center" VALIGN="top">
    41. 

  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    42. 

  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    43. 

  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    44. 

  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HierarchicalStreamReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    45. 

  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    46. 

  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    47. 

  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    48. 

  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    49. 

  49.   </TR>
    50. 

  50. </TABLE>
    51. 

  51. </TD>
    52. 

  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    53. 

  53. </EM>
    54. 

  54. </TD>
    55. 

  55. </TR>
    56. 

  56. 

  57. <TR>
    58. 

  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    59. 

  59. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamDriver.html" title="interface in com.thoughtworks.xstream.io"><B>PREV CLASS</B></A>&nbsp;
    60. 

  60. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io"><B>NEXT CLASS</B></A></FONT></TD>
    61. 

  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    62. 

  62.   <A HREF="../../../../index.html?com/thoughtworks/xstream/io/HierarchicalStreamReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    63. 

  63. &nbsp;<A HREF="HierarchicalStreamReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    64. 

  64. &nbsp;<SCRIPT type="text/javascript">
    65. 

  65.   <!--
    66. 

  66.   if(window==top) {
    67. 

  67.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    68. 

  68.   }
    69. 

  69.   //-->
    70. 

  70. </SCRIPT>
    71. 

  71. <NOSCRIPT>
    72. 

  72.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    73. 

  73. </NOSCRIPT>
    74. 

  74. 

  75. 

  76. </FONT></TD>
    77. 

  77. </TR>
    78. 

  78. <TR>
    79. 

  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    80. 

  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    81. 

  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    82. 

  82. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    83. 

  83. </TR>
    84. 

  84. </TABLE>
    85. 

  85. <A NAME="skip-navbar_top"></A>
    86. 

  86. <!-- ========= END OF TOP NAVBAR ========= -->
    87. 

  87. 

  88. <HR>
    89. 

  89. <!-- ======== START OF CLASS DATA ======== -->
    90. 

  90. <H2>
    91. 

  91. <FONT SIZE="-1">
    92. 

  92. com.thoughtworks.xstream.io</FONT>
    93. 

  93. <BR>
    94. 

  94. Interface HierarchicalStreamReader</H2>
    95. 

  95. <DL>
    96. 

  96. <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorReporter.html" title="interface in com.thoughtworks.xstream.converters">ErrorReporter</A></DD>
    97. 

  97. </DL>
    98. 

  98. <DL>
    99. 

  99. <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../com/thoughtworks/xstream/io/xml/DocumentReader.html" title="interface in com.thoughtworks.xstream.io.xml">DocumentReader</A></DD>
    100. 

  100. </DL>
    101. 

  101. <DL>
    102. 

  102. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractDocumentReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html" title="class in com.thoughtworks.xstream.io">AbstractReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/binary/BinaryStreamReader.html" title="class in com.thoughtworks.xstream.io.binary">BinaryStreamReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/Dom4JReader.html" title="class in com.thoughtworks.xstream.io.xml">Dom4JReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/DomReader.html" title="class in com.thoughtworks.xstream.io.xml">DomReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/JDomReader.html" title="class in com.thoughtworks.xstream.io.xml">JDomReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/path/PathTrackingReader.html" title="class in com.thoughtworks.xstream.io.path">PathTrackingReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/ReaderWrapper.html" title="class in com.thoughtworks.xstream.io">ReaderWrapper</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/StaxReader.html" title="class in com.thoughtworks.xstream.io.xml">StaxReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/XomReader.html" title="class in com.thoughtworks.xstream.io.xml">XomReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/XppDomReader.html" title="class in com.thoughtworks.xstream.io.xml">XppDomReader</A>, <A HREF="../../../../com/thoughtworks/xstream/io/xml/XppReader.html" title="class in com.thoughtworks.xstream.io.xml">XppReader</A></DD>
    103. 

  103. </DL>
    104. 

  104. <HR>
    105. 

  105. <DL>
    106. 

  106. <DT><PRE>public interface <B>HierarchicalStreamReader</B><DT>extends <A HREF="../../../../com/thoughtworks/xstream/converters/ErrorReporter.html" title="interface in com.thoughtworks.xstream.converters">ErrorReporter</A></DL>
    107. 

  107. </PRE>
    108. 

  108. 

  109. <P>
    110. 

  110. <DL>
    111. 

  111. <DT><B>Author:</B></DT>
    112. 

  112.   <DD>Joe Walnes</DD>
    113. 

  113. </DL>
    114. 

  114. <HR>
    115. 

  115. 

  116. <P>
    117. 

  117. 

  118. <!-- ========== METHOD SUMMARY =========== -->
    119. 

  119. 

  120. <A NAME="method_summary"><!-- --></A>
    121. 

  121. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    122. 

  122. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    123. 

  123. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    124. 

  124. <B>Method Summary</B></FONT></TH>
    125. 

  125. </TR>
    126. 

  126. <TR BGCOLOR="white" CLASS="TableRowColor">
    127. 

  127. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    128. 

  128. <CODE>&nbsp;void</CODE></FONT></TD>
    129. 

  129. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)">appendErrors</A></B>(<A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html" title="interface in com.thoughtworks.xstream.converters">ErrorWriter</A>&nbsp;errorWriter)</CODE>
    130. 

  130. 

  131. <BR>
    132. 

  132. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If any errors are detected, allow the reader to add any additional information that can aid debugging
    133. 

  133.  (such as line numbers, XPath expressions, etc).</TD>
    134. 

  134. </TR>
    135. 

  135. <TR BGCOLOR="white" CLASS="TableRowColor">
    136. 

  136. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    137. 

  137. <CODE>&nbsp;void</CODE></FONT></TD>
    138. 

  138. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#close()">close</A></B>()</CODE>
    139. 

  139. 

  140. <BR>
    141. 

  141. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the reader, if necessary.</TD>
    142. 

  142. </TR>
    143. 

  143. <TR BGCOLOR="white" CLASS="TableRowColor">
    144. 

  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    145. 

  145. <CODE>&nbsp;<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></CODE></FONT></TD>
    146. 

  146. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(int)">getAttribute</A></B>(int&nbsp;index)</CODE>
    147. 

  147. 

  148. <BR>
    149. 

  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of an attribute of the current node, by index.</TD>
    150. 

  150. </TR>
    151. 

  151. <TR BGCOLOR="white" CLASS="TableRowColor">
    152. 

  152. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    153. 

  153. <CODE>&nbsp;<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></CODE></FONT></TD>
    154. 

  154. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(java.lang.String)">getAttribute</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>
    155. 

  155. 

  156. <BR>
    157. 

  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of an attribute of the current node.</TD>
    158. 

  158. </TR>
    159. 

  159. <TR BGCOLOR="white" CLASS="TableRowColor">
    160. 

  160. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    161. 

  161. <CODE>&nbsp;int</CODE></FONT></TD>
    162. 

  162. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeCount()">getAttributeCount</A></B>()</CODE>
    163. 

  163. 

  164. <BR>
    165. 

  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of attributes in current node.</TD>
    166. 

  166. </TR>
    167. 

  167. <TR BGCOLOR="white" CLASS="TableRowColor">
    168. 

  168. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    169. 

  169. <CODE>&nbsp;<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></CODE></FONT></TD>
    170. 

  170. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeName(int)">getAttributeName</A></B>(int&nbsp;index)</CODE>
    171. 

  171. 

  172. <BR>
    173. 

  173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of attribute in current node.</TD>
    174. 

  174. </TR>
    175. 

  175. <TR BGCOLOR="white" CLASS="TableRowColor">
    176. 

  176. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    177. 

  177. <CODE>&nbsp;<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A></CODE></FONT></TD>
    178. 

  178. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeNames()">getAttributeNames</A></B>()</CODE>
    179. 

  179. 

  180. <BR>
    181. 

  181. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Names of attributes (as Strings).</TD>
    182. 

  182. </TR>
    183. 

  183. <TR BGCOLOR="white" CLASS="TableRowColor">
    184. 

  184. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    185. 

  185. <CODE>&nbsp;<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></CODE></FONT></TD>
    186. 

  186. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getNodeName()">getNodeName</A></B>()</CODE>
    187. 

  187. 

  188. <BR>
    189. 

  189. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the current node.</TD>
    190. 

  190. </TR>
    191. 

  191. <TR BGCOLOR="white" CLASS="TableRowColor">
    192. 

  192. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    193. 

  193. <CODE>&nbsp;<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></CODE></FONT></TD>
    194. 

  194. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getValue()">getValue</A></B>()</CODE>
    195. 

  195. 

  196. <BR>
    197. 

  197. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value (text content) of the current node.</TD>
    198. 

  198. </TR>
    199. 

  199. <TR BGCOLOR="white" CLASS="TableRowColor">
    200. 

  200. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    201. 

  201. <CODE>&nbsp;boolean</CODE></FONT></TD>
    202. 

  202. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#hasMoreChildren()">hasMoreChildren</A></B>()</CODE>
    203. 

  203. 

  204. <BR>
    205. 

  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Does the node have any more children remaining that have not yet been read?</TD>
    206. 

  206. </TR>
    207. 

  207. <TR BGCOLOR="white" CLASS="TableRowColor">
    208. 

  208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    209. 

  209. <CODE>&nbsp;void</CODE></FONT></TD>
    210. 

  210. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveDown()">moveDown</A></B>()</CODE>
    211. 

  211. 

  212. <BR>
    213. 

  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Select the current child as current node.</TD>
    214. 

  214. </TR>
    215. 

  215. <TR BGCOLOR="white" CLASS="TableRowColor">
    216. 

  216. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    217. 

  217. <CODE>&nbsp;void</CODE></FONT></TD>
    218. 

  218. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveUp()">moveUp</A></B>()</CODE>
    219. 

  219. 

  220. <BR>
    221. 

  221. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Select the parent node as current node.</TD>
    222. 

  222. </TR>
    223. 

  223. <TR BGCOLOR="white" CLASS="TableRowColor">
    224. 

  224. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    225. 

  225. <CODE>&nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></CODE></FONT></TD>
    226. 

  226. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#underlyingReader()">underlyingReader</A></B>()</CODE>
    227. 

  227. 

  228. <BR>
    229. 

  229. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the underlying HierarchicalStreamReader implementation.</TD>
    230. 

  230. </TR>
    231. 

  231. </TABLE>
    232. 

  232. &nbsp;
    233. 

  233. <P>
    234. 

  234. 

  235. <!-- ============ METHOD DETAIL ========== -->
    236. 

  236. 

  237. <A NAME="method_detail"><!-- --></A>
    238. 

  238. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    239. 

  239. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    240. 

  240. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    241. 

  241. <B>Method Detail</B></FONT></TH>
    242. 

  242. </TR>
    243. 

  243. </TABLE>
    244. 

  244. 

  245. <A NAME="hasMoreChildren()"><!-- --></A><H3>
    246. 

  246. hasMoreChildren</H3>
    247. 

  247. <PRE>
    248. 

  248. boolean <B>hasMoreChildren</B>()</PRE>
    249. 

  249. <DL>
    250. 

  250. <DD>Does the node have any more children remaining that have not yet been read?
    251. 

  251. <P>
    252. 

  252. <DD><DL>
    253. 

  253. </DL>
    254. 

  254. </DD>
    255. 

  255. <DD><DL>
    256. 

  256. </DL>
    257. 

  257. </DD>
    258. 

  258. </DL>
    259. 

  259. <HR>
    260. 

  260. 

  261. <A NAME="moveDown()"><!-- --></A><H3>
    262. 

  262. moveDown</H3>
    263. 

  263. <PRE>
    264. 

  264. void <B>moveDown</B>()</PRE>
    265. 

  265. <DL>
    266. 

  266. <DD>Select the current child as current node.
    267. 

  267.  A call to this function must be balanced with a call to <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveUp()"><CODE>moveUp()</CODE></A>.
    268. 

  268. <P>
    269. 

  269. <DD><DL>
    270. 

  270. </DL>
    271. 

  271. </DD>
    272. 

  272. <DD><DL>
    273. 

  273. </DL>
    274. 

  274. </DD>
    275. 

  275. </DL>
    276. 

  276. <HR>
    277. 

  277. 

  278. <A NAME="moveUp()"><!-- --></A><H3>
    279. 

  279. moveUp</H3>
    280. 

  280. <PRE>
    281. 

  281. void <B>moveUp</B>()</PRE>
    282. 

  282. <DL>
    283. 

  283. <DD>Select the parent node as current node.
    284. 

  284. <P>
    285. 

  285. <DD><DL>
    286. 

  286. </DL>
    287. 

  287. </DD>
    288. 

  288. <DD><DL>
    289. 

  289. </DL>
    290. 

  290. </DD>
    291. 

  291. </DL>
    292. 

  292. <HR>
    293. 

  293. 

  294. <A NAME="getNodeName()"><!-- --></A><H3>
    295. 

  295. getNodeName</H3>
    296. 

  296. <PRE>
    297. 

  297. <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> <B>getNodeName</B>()</PRE>
    298. 

  298. <DL>
    299. 

  299. <DD>Get the name of the current node.
    300. 

  300. <P>
    301. 

  301. <DD><DL>
    302. 

  302. </DL>
    303. 

  303. </DD>
    304. 

  304. <DD><DL>
    305. 

  305. </DL>
    306. 

  306. </DD>
    307. 

  307. </DL>
    308. 

  308. <HR>
    309. 

  309. 

  310. <A NAME="getValue()"><!-- --></A><H3>
    311. 

  311. getValue</H3>
    312. 

  312. <PRE>
    313. 

  313. <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> <B>getValue</B>()</PRE>
    314. 

  314. <DL>
    315. 

  315. <DD>Get the value (text content) of the current node.
    316. 

  316. <P>
    317. 

  317. <DD><DL>
    318. 

  318. </DL>
    319. 

  319. </DD>
    320. 

  320. <DD><DL>
    321. 

  321. </DL>
    322. 

  322. </DD>
    323. 

  323. </DL>
    324. 

  324. <HR>
    325. 

  325. 

  326. <A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
    327. 

  327. getAttribute</H3>
    328. 

  328. <PRE>
    329. 

  329. <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> <B>getAttribute</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>
    330. 

  330. <DL>
    331. 

  331. <DD>Get the value of an attribute of the current node.
    332. 

  332. <P>
    333. 

  333. <DD><DL>
    334. 

  334. </DL>
    335. 

  335. </DD>
    336. 

  336. <DD><DL>
    337. 

  337. </DL>
    338. 

  338. </DD>
    339. 

  339. </DL>
    340. 

  340. <HR>
    341. 

  341. 

  342. <A NAME="getAttribute(int)"><!-- --></A><H3>
    343. 

  343. getAttribute</H3>
    344. 

  344. <PRE>
    345. 

  345. <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> <B>getAttribute</B>(int&nbsp;index)</PRE>
    346. 

  346. <DL>
    347. 

  347. <DD>Get the value of an attribute of the current node, by index.
    348. 

  348. <P>
    349. 

  349. <DD><DL>
    350. 

  350. </DL>
    351. 

  351. </DD>
    352. 

  352. <DD><DL>
    353. 

  353. </DL>
    354. 

  354. </DD>
    355. 

  355. </DL>
    356. 

  356. <HR>
    357. 

  357. 

  358. <A NAME="getAttributeCount()"><!-- --></A><H3>
    359. 

  359. getAttributeCount</H3>
    360. 

  360. <PRE>
    361. 

  361. int <B>getAttributeCount</B>()</PRE>
    362. 

  362. <DL>
    363. 

  363. <DD>Number of attributes in current node.
    364. 

  364. <P>
    365. 

  365. <DD><DL>
    366. 

  366. </DL>
    367. 

  367. </DD>
    368. 

  368. <DD><DL>
    369. 

  369. </DL>
    370. 

  370. </DD>
    371. 

  371. </DL>
    372. 

  372. <HR>
    373. 

  373. 

  374. <A NAME="getAttributeName(int)"><!-- --></A><H3>
    375. 

  375. getAttributeName</H3>
    376. 

  376. <PRE>
    377. 

  377. <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> <B>getAttributeName</B>(int&nbsp;index)</PRE>
    378. 

  378. <DL>
    379. 

  379. <DD>Name of attribute in current node.
    380. 

  380. <P>
    381. 

  381. <DD><DL>
    382. 

  382. </DL>
    383. 

  383. </DD>
    384. 

  384. <DD><DL>
    385. 

  385. </DL>
    386. 

  386. </DD>
    387. 

  387. </DL>
    388. 

  388. <HR>
    389. 

  389. 

  390. <A NAME="getAttributeNames()"><!-- --></A><H3>
    391. 

  391. getAttributeNames</H3>
    392. 

  392. <PRE>
    393. 

  393. <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A> <B>getAttributeNames</B>()</PRE>
    394. 

  394. <DL>
    395. 

  395. <DD>Names of attributes (as Strings).
    396. 

  396. <P>
    397. 

  397. <DD><DL>
    398. 

  398. </DL>
    399. 

  399. </DD>
    400. 

  400. <DD><DL>
    401. 

  401. </DL>
    402. 

  402. </DD>
    403. 

  403. </DL>
    404. 

  404. <HR>
    405. 

  405. 

  406. <A NAME="appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)"><!-- --></A><H3>
    407. 

  407. appendErrors</H3>
    408. 

  408. <PRE>
    409. 

  409. void <B>appendErrors</B>(<A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html" title="interface in com.thoughtworks.xstream.converters">ErrorWriter</A>&nbsp;errorWriter)</PRE>
    410. 

  410. <DL>
    411. 

  411. <DD>If any errors are detected, allow the reader to add any additional information that can aid debugging
    412. 

  412.  (such as line numbers, XPath expressions, etc).
    413. 

  413. <P>
    414. 

  414. <DD><DL>
    415. 

  415. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorReporter.html#appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)">appendErrors</A></CODE> in interface <CODE><A HREF="../../../../com/thoughtworks/xstream/converters/ErrorReporter.html" title="interface in com.thoughtworks.xstream.converters">ErrorReporter</A></CODE></DL>
    416. 

  416. </DD>
    417. 

  417. <DD><DL>
    418. 

  418. <DT><B>Parameters:</B><DD><CODE>errorWriter</CODE> - the error writer</DL>
    419. 

  419. </DD>
    420. 

  420. </DL>
    421. 

  421. <HR>
    422. 

  422. 

  423. <A NAME="close()"><!-- --></A><H3>
    424. 

  424. close</H3>
    425. 

  425. <PRE>
    426. 

  426. void <B>close</B>()</PRE>
    427. 

  427. <DL>
    428. 

  428. <DD>Close the reader, if necessary.
    429. 

  429. <P>
    430. 

  430. <DD><DL>
    431. 

  431. </DL>
    432. 

  432. </DD>
    433. 

  433. <DD><DL>
    434. 

  434. </DL>
    435. 

  435. </DD>
    436. 

  436. </DL>
    437. 

  437. <HR>
    438. 

  438. 

  439. <A NAME="underlyingReader()"><!-- --></A><H3>
    440. 

  440. underlyingReader</H3>
    441. 

  441. <PRE>
    442. 

  442. <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A> <B>underlyingReader</B>()</PRE>
    443. 

  443. <DL>
    444. 

  444. <DD>Return the underlying HierarchicalStreamReader implementation.
    445. 

  445. 

  446.  <p>If a Converter needs to access methods of a specific HierarchicalStreamReader implementation that are not
    447. 

  447.  defined in the HierarchicalStreamReader interface, it should call this method before casting. This is because
    448. 

  448.  the reader passed to the Converter is often wrapped/decorated by another implementation to provide additional
    449. 

  449.  functionality (such as XPath tracking).</p>
    450. 

  450. 

  451.  <p>For example:</p>
    452. 

  452.  <pre>MySpecificReader mySpecificReader = (MySpecificReader)reader; <b>// INCORRECT!</b>
    453. 

  453.  mySpecificReader.doSomethingSpecific();</pre>
    454. 

  454. 

  455.  <pre>MySpecificReader mySpecificReader = (MySpecificReader)reader.underlyingReader();  <b>// CORRECT!</b>
    456. 

  456.  mySpecificReader.doSomethingSpecific();</pre>
    457. 

  457. 

  458.  <p>Implementations of HierarchicalStreamReader should return 'this', unless they are a decorator, in which case
    459. 

  459.  they should delegate to whatever they are wrapping.</p>
    460. 

  460. <P>
    461. 

  461. <DD><DL>
    462. 

  462. </DL>
    463. 

  463. </DD>
    464. 

  464. <DD><DL>
    465. 

  465. </DL>
    466. 

  466. </DD>
    467. 

  467. </DL>
    468. 

  468. <!-- ========= END OF CLASS DATA ========= -->
    469. 

  469. <HR>
    470. 

  470. 

  471. 

  472. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    473. 

  473. <A NAME="navbar_bottom"><!-- --></A>
    474. 

  474. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    475. 

  475. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    476. 

  476. <TR>
    477. 

  477. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    478. 

  478. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    479. 

  479. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    480. 

  480.   <TR ALIGN="center" VALIGN="top">
    481. 

  481.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    482. 

  482.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    483. 

  483.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    484. 

  484.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HierarchicalStreamReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    485. 

  485.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    486. 

  486.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    487. 

  487.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    488. 

  488.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    489. 

  489.   </TR>
    490. 

  490. </TABLE>
    491. 

  491. </TD>
    492. 

  492. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    493. 

  493. </EM>
    494. 

  494. </TD>
    495. 

  495. </TR>
    496. 

  496. 

  497. <TR>
    498. 

  498. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    499. 

  499. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamDriver.html" title="interface in com.thoughtworks.xstream.io"><B>PREV CLASS</B></A>&nbsp;
    500. 

  500. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io"><B>NEXT CLASS</B></A></FONT></TD>
    501. 

  501. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    502. 

  502.   <A HREF="../../../../index.html?com/thoughtworks/xstream/io/HierarchicalStreamReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    503. 

  503. &nbsp;<A HREF="HierarchicalStreamReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    504. 

  504. &nbsp;<SCRIPT type="text/javascript">
    505. 

  505.   <!--
    506. 

  506.   if(window==top) {
    507. 

  507.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
    508. 

  508.   }
    509. 

  509.   //-->
    510. 

  510. </SCRIPT>
    511. 

  511. <NOSCRIPT>
    512. 

  512.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    513. 

  513. </NOSCRIPT>
    514. 

  514. 

  515. 

  516. </FONT></TD>
    517. 

  517. </TR>
    518. 

  518. <TR>
    519. 

  519. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    520. 

  520.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    521. 

  521. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    522. 

  522. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    523. 

  523. </TR>
    524. 

  524. </TABLE>
    525. 

  525. <A NAME="skip-navbar_bottom"></A>
    526. 

  526. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    527. 

  527. 

  528. <HR>
    529. 

  529. Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
    530. 

  530. </BODY>
    531. 

  531. </HTML>
    532.