PageRenderTime 59ms CodeModel.GetById 11ms app.highlight 41ms RepoModel.GetById 1ms app.codeStats 1ms

/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<!--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>
  8HierarchicalStreamReader (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="HierarchicalStreamReader (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>&nbsp;</TD>
 42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 43  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HierarchicalStreamReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 48  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamDriver.html" title="interface in com.thoughtworks.xstream.io"><B>PREV CLASS</B></A>&nbsp;
 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<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 62  <A HREF="../../../../index.html?com/thoughtworks/xstream/io/HierarchicalStreamReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 63&nbsp;<A HREF="HierarchicalStreamReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 64&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 82DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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</FONT>
 93<BR>
 94Interface HierarchicalStreamReader</H2>
 95<DL>
 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</DL>
 98<DL>
 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</DL>
101<DL>
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</DL>
104<HR>
105<DL>
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</PRE>
108
109<P>
110<DL>
111<DT><B>Author:</B></DT>
112  <DD>Joe Walnes</DD>
113</DL>
114<HR>
115
116<P>
117
118<!-- ========== METHOD SUMMARY =========== -->
119
120<A NAME="method_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
124<B>Method Summary</B></FONT></TH>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>&nbsp;void</CODE></FONT></TD>
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
131<BR>
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 (such as line numbers, XPath expressions, etc).</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;void</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#close()">close</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the reader, if necessary.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
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<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(int)">getAttribute</A></B>(int&nbsp;index)</CODE>
147
148<BR>
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</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
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<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
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of an attribute of the current node.</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;int</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeCount()">getAttributeCount</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of attributes in current node.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
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<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeName(int)">getAttributeName</A></B>(int&nbsp;index)</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of attribute in current node.</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
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<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeNames()">getAttributeNames</A></B>()</CODE>
179
180<BR>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Names of attributes (as Strings).</TD>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
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<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getNodeName()">getNodeName</A></B>()</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the current node.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
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<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getValue()">getValue</A></B>()</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value (text content) of the current node.</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;boolean</CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#hasMoreChildren()">hasMoreChildren</A></B>()</CODE>
203
204<BR>
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</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;void</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveDown()">moveDown</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Select the current child as current node.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;void</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveUp()">moveUp</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Select the parent node as current node.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>&nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#underlyingReader()">underlyingReader</A></B>()</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the underlying HierarchicalStreamReader implementation.</TD>
230</TR>
231</TABLE>
232&nbsp;
233<P>
234
235<!-- ============ METHOD DETAIL ========== -->
236
237<A NAME="method_detail"><!-- --></A>
238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
239<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
240<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
241<B>Method Detail</B></FONT></TH>
242</TR>
243</TABLE>
244
245<A NAME="hasMoreChildren()"><!-- --></A><H3>
246hasMoreChildren</H3>
247<PRE>
248boolean <B>hasMoreChildren</B>()</PRE>
249<DL>
250<DD>Does the node have any more children remaining that have not yet been read?
251<P>
252<DD><DL>
253</DL>
254</DD>
255<DD><DL>
256</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="moveDown()"><!-- --></A><H3>
262moveDown</H3>
263<PRE>
264void <B>moveDown</B>()</PRE>
265<DL>
266<DD>Select the current child as current node.
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<P>
269<DD><DL>
270</DL>
271</DD>
272<DD><DL>
273</DL>
274</DD>
275</DL>
276<HR>
277
278<A NAME="moveUp()"><!-- --></A><H3>
279moveUp</H3>
280<PRE>
281void <B>moveUp</B>()</PRE>
282<DL>
283<DD>Select the parent node as current node.
284<P>
285<DD><DL>
286</DL>
287</DD>
288<DD><DL>
289</DL>
290</DD>
291</DL>
292<HR>
293
294<A NAME="getNodeName()"><!-- --></A><H3>
295getNodeName</H3>
296<PRE>
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<DL>
299<DD>Get the name of the current node.
300<P>
301<DD><DL>
302</DL>
303</DD>
304<DD><DL>
305</DL>
306</DD>
307</DL>
308<HR>
309
310<A NAME="getValue()"><!-- --></A><H3>
311getValue</H3>
312<PRE>
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<DL>
315<DD>Get the value (text content) of the current node.
316<P>
317<DD><DL>
318</DL>
319</DD>
320<DD><DL>
321</DL>
322</DD>
323</DL>
324<HR>
325
326<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
327getAttribute</H3>
328<PRE>
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<DL>
331<DD>Get the value of an attribute of the current node.
332<P>
333<DD><DL>
334</DL>
335</DD>
336<DD><DL>
337</DL>
338</DD>
339</DL>
340<HR>
341
342<A NAME="getAttribute(int)"><!-- --></A><H3>
343getAttribute</H3>
344<PRE>
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<DL>
347<DD>Get the value of an attribute of the current node, by index.
348<P>
349<DD><DL>
350</DL>
351</DD>
352<DD><DL>
353</DL>
354</DD>
355</DL>
356<HR>
357
358<A NAME="getAttributeCount()"><!-- --></A><H3>
359getAttributeCount</H3>
360<PRE>
361int <B>getAttributeCount</B>()</PRE>
362<DL>
363<DD>Number of attributes in current node.
364<P>
365<DD><DL>
366</DL>
367</DD>
368<DD><DL>
369</DL>
370</DD>
371</DL>
372<HR>
373
374<A NAME="getAttributeName(int)"><!-- --></A><H3>
375getAttributeName</H3>
376<PRE>
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<DL>
379<DD>Name of attribute in current node.
380<P>
381<DD><DL>
382</DL>
383</DD>
384<DD><DL>
385</DL>
386</DD>
387</DL>
388<HR>
389
390<A NAME="getAttributeNames()"><!-- --></A><H3>
391getAttributeNames</H3>
392<PRE>
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<DL>
395<DD>Names of attributes (as Strings).
396<P>
397<DD><DL>
398</DL>
399</DD>
400<DD><DL>
401</DL>
402</DD>
403</DL>
404<HR>
405
406<A NAME="appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)"><!-- --></A><H3>
407appendErrors</H3>
408<PRE>
409void <B>appendErrors</B>(<A HREF="../../../../com/thoughtworks/xstream/converters/ErrorWriter.html" title="interface in com.thoughtworks.xstream.converters">ErrorWriter</A>&nbsp;errorWriter)</PRE>
410<DL>
411<DD>If any errors are detected, allow the reader to add any additional information that can aid debugging
412 (such as line numbers, XPath expressions, etc).
413<P>
414<DD><DL>
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</DD>
417<DD><DL>
418<DT><B>Parameters:</B><DD><CODE>errorWriter</CODE> - the error writer</DL>
419</DD>
420</DL>
421<HR>
422
423<A NAME="close()"><!-- --></A><H3>
424close</H3>
425<PRE>
426void <B>close</B>()</PRE>
427<DL>
428<DD>Close the reader, if necessary.
429<P>
430<DD><DL>
431</DL>
432</DD>
433<DD><DL>
434</DL>
435</DD>
436</DL>
437<HR>
438
439<A NAME="underlyingReader()"><!-- --></A><H3>
440underlyingReader</H3>
441<PRE>
442<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A> <B>underlyingReader</B>()</PRE>
443<DL>
444<DD>Return the underlying HierarchicalStreamReader implementation.
445
446 <p>If a Converter needs to access methods of a specific HierarchicalStreamReader implementation that are not
447 defined in the HierarchicalStreamReader interface, it should call this method before casting. This is because
448 the reader passed to the Converter is often wrapped/decorated by another implementation to provide additional
449 functionality (such as XPath tracking).</p>
450
451 <p>For example:</p>
452 <pre>MySpecificReader mySpecificReader = (MySpecificReader)reader; <b>// INCORRECT!</b>
453 mySpecificReader.doSomethingSpecific();</pre>
454
455 <pre>MySpecificReader mySpecificReader = (MySpecificReader)reader.underlyingReader();  <b>// CORRECT!</b>
456 mySpecificReader.doSomethingSpecific();</pre>
457
458 <p>Implementations of HierarchicalStreamReader should return 'this', unless they are a decorator, in which case
459 they should delegate to whatever they are wrapping.</p>
460<P>
461<DD><DL>
462</DL>
463</DD>
464<DD><DL>
465</DL>
466</DD>
467</DL>
468<!-- ========= END OF CLASS DATA ========= -->
469<HR>
470
471
472<!-- ======= START OF BOTTOM NAVBAR ====== -->
473<A NAME="navbar_bottom"><!-- --></A>
474<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
475<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
476<TR>
477<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
478<A NAME="navbar_bottom_firstrow"><!-- --></A>
479<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
480  <TR ALIGN="center" VALIGN="top">
481  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
482  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
483  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
484  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HierarchicalStreamReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
485  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
486  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
487  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
488  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
489  </TR>
490</TABLE>
491</TD>
492<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
493</EM>
494</TD>
495</TR>
496
497<TR>
498<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
499&nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamDriver.html" title="interface in com.thoughtworks.xstream.io"><B>PREV CLASS</B></A>&nbsp;
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<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
502  <A HREF="../../../../index.html?com/thoughtworks/xstream/io/HierarchicalStreamReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
503&nbsp;<A HREF="HierarchicalStreamReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
504&nbsp;<SCRIPT type="text/javascript">
505  <!--
506  if(window==top) {
507    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
508  }
509  //-->
510</SCRIPT>
511<NOSCRIPT>
512  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
513</NOSCRIPT>
514
515
516</FONT></TD>
517</TR>
518<TR>
519<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
520  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
521<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
522DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
523</TR>
524</TABLE>
525<A NAME="skip-navbar_bottom"></A>
526<!-- ======== END OF BOTTOM NAVBAR ======= -->
527
528<HR>
529Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
530</BODY>
531</HTML>