/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/AbstractPullReader.html
HTML | 654 lines | 563 code | 67 blank | 24 comment | 0 complexity | a6ae58c9ffae031feef676424a6880b2 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> 8AbstractPullReader (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="AbstractPullReader (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/AbstractPullReader.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/AbstractDocumentWriter.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlDriver.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/AbstractPullReader.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="AbstractPullReader.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#field_detail">FIELD</A> | <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 AbstractPullReader</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/AbstractReader.html" title="class in com.thoughtworks.xstream.io">com.thoughtworks.xstream.io.AbstractReader</A> 98 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html" title="class in com.thoughtworks.xstream.io.xml">com.thoughtworks.xstream.io.xml.AbstractXmlReader</A> 99 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.xml.AbstractPullReader</B> 100</PRE> 101<DL> 102<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/converters/ErrorReporter.html" title="interface in com.thoughtworks.xstream.converters">ErrorReporter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></DD> 103</DL> 104<DL> 105<DT><B>Direct Known Subclasses:</B> <DD><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/XppReader.html" title="class in com.thoughtworks.xstream.io.xml">XppReader</A></DD> 106</DL> 107<HR> 108<DL> 109<DT><PRE>public abstract class <B>AbstractPullReader</B><DT>extends <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlReader</A></DL> 110</PRE> 111 112<P> 113Base class that contains common functionality across HierarchicalStreamReader implementations 114 that need to read from a pull parser. 115<P> 116 117<P> 118<DL> 119<DT><B>Author:</B></DT> 120 <DD>Joe Walnes, James Strachan</DD> 121</DL> 122<HR> 123 124<P> 125<!-- =========== FIELD SUMMARY =========== --> 126 127<A NAME="field_summary"><!-- --></A> 128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131<B>Field Summary</B></FONT></TH> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 135<CODE>protected static int</CODE></FONT></TD> 136<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#COMMENT">COMMENT</A></B></CODE> 137 138<BR> 139 </TD> 140</TR> 141<TR BGCOLOR="white" CLASS="TableRowColor"> 142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 143<CODE>protected static int</CODE></FONT></TD> 144<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#END_NODE">END_NODE</A></B></CODE> 145 146<BR> 147 </TD> 148</TR> 149<TR BGCOLOR="white" CLASS="TableRowColor"> 150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 151<CODE>protected static int</CODE></FONT></TD> 152<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#OTHER">OTHER</A></B></CODE> 153 154<BR> 155 </TD> 156</TR> 157<TR BGCOLOR="white" CLASS="TableRowColor"> 158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 159<CODE>protected static int</CODE></FONT></TD> 160<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#START_NODE">START_NODE</A></B></CODE> 161 162<BR> 163 </TD> 164</TR> 165<TR BGCOLOR="white" CLASS="TableRowColor"> 166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 167<CODE>protected static int</CODE></FONT></TD> 168<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#TEXT">TEXT</A></B></CODE> 169 170<BR> 171 </TD> 172</TR> 173</TABLE> 174 175<!-- ======== CONSTRUCTOR SUMMARY ======== --> 176 177<A NAME="constructor_summary"><!-- --></A> 178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 179<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 180<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 181<B>Constructor Summary</B></FONT></TH> 182</TR> 183<TR BGCOLOR="white" CLASS="TableRowColor"> 184<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 185<CODE>protected </CODE></FONT></TD> 186<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#AbstractPullReader(com.thoughtworks.xstream.io.naming.NameCoder)">AbstractPullReader</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 187 188<BR> 189 </TD> 190</TR> 191<TR BGCOLOR="white" CLASS="TableRowColor"> 192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 193<CODE>protected </CODE></FONT></TD> 194<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#AbstractPullReader(com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)">AbstractPullReader</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</CODE> 195 196<BR> 197 <B>Deprecated.</B> <I>As of 1.4 use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#AbstractPullReader(com.thoughtworks.xstream.io.naming.NameCoder)"><CODE>AbstractPullReader(NameCoder)</CODE></A> instead</I></TD> 198</TR> 199</TABLE> 200 201<!-- ========== METHOD SUMMARY =========== --> 202 203<A NAME="method_summary"><!-- --></A> 204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 206<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 207<B>Method Summary</B></FONT></TH> 208</TR> 209<TR BGCOLOR="white" CLASS="TableRowColor"> 210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 211<CODE> <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> 212<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#getAttributeNames()">getAttributeNames</A></B>()</CODE> 213 214<BR> 215 Names of attributes (as Strings).</TD> 216</TR> 217<TR BGCOLOR="white" CLASS="TableRowColor"> 218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 219<CODE> <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> 220<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#getNodeName()">getNodeName</A></B>()</CODE> 221 222<BR> 223 Get the name of the current node.</TD> 224</TR> 225<TR BGCOLOR="white" CLASS="TableRowColor"> 226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 227<CODE> <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> 228<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#getValue()">getValue</A></B>()</CODE> 229 230<BR> 231 Get the value (text content) of the current node.</TD> 232</TR> 233<TR BGCOLOR="white" CLASS="TableRowColor"> 234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 235<CODE> boolean</CODE></FONT></TD> 236<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#hasMoreChildren()">hasMoreChildren</A></B>()</CODE> 237 238<BR> 239 Does the node have any more children remaining that have not yet been read?</TD> 240</TR> 241<TR BGCOLOR="white" CLASS="TableRowColor"> 242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 243<CODE> void</CODE></FONT></TD> 244<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#mark()">mark</A></B>()</CODE> 245 246<BR> 247 </TD> 248</TR> 249<TR BGCOLOR="white" CLASS="TableRowColor"> 250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 251<CODE> void</CODE></FONT></TD> 252<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#moveDown()">moveDown</A></B>()</CODE> 253 254<BR> 255 Select the current child as current node.</TD> 256</TR> 257<TR BGCOLOR="white" CLASS="TableRowColor"> 258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 259<CODE> void</CODE></FONT></TD> 260<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#moveUp()">moveUp</A></B>()</CODE> 261 262<BR> 263 Select the parent node as current node.</TD> 264</TR> 265<TR BGCOLOR="white" CLASS="TableRowColor"> 266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 267<CODE>protected abstract <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> 268<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullElementName()">pullElementName</A></B>()</CODE> 269 270<BR> 271 Pull the name of the current element from the stream.</TD> 272</TR> 273<TR BGCOLOR="white" CLASS="TableRowColor"> 274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 275<CODE>protected abstract int</CODE></FONT></TD> 276<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullNextEvent()">pullNextEvent</A></B>()</CODE> 277 278<BR> 279 Pull the next event from the stream.</TD> 280</TR> 281<TR BGCOLOR="white" CLASS="TableRowColor"> 282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 283<CODE>protected abstract <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> 284<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullText()">pullText</A></B>()</CODE> 285 286<BR> 287 Pull the contents of the current text node from the stream.</TD> 288</TR> 289<TR BGCOLOR="white" CLASS="TableRowColor"> 290<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 291<CODE> void</CODE></FONT></TD> 292<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#reset()">reset</A></B>()</CODE> 293 294<BR> 295 </TD> 296</TR> 297</TABLE> 298 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractXmlReader"><!-- --></A> 299<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 300<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 301<TH ALIGN="left"><B>Methods inherited from class com.thoughtworks.xstream.io.xml.<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlReader</A></B></TH> 302</TR> 303<TR BGCOLOR="white" CLASS="TableRowColor"> 304<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html#escapeXmlName(java.lang.String)">escapeXmlName</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html#unescapeXmlName(java.lang.String)">unescapeXmlName</A></CODE></TD> 305</TR> 306</TABLE> 307 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.AbstractReader"><!-- --></A> 308<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 309<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 310<TH ALIGN="left"><B>Methods inherited from class com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/AbstractReader.html" title="class in com.thoughtworks.xstream.io">AbstractReader</A></B></TH> 311</TR> 312<TR BGCOLOR="white" CLASS="TableRowColor"> 313<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractReader.html#decodeAttribute(java.lang.String)">decodeAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractReader.html#decodeNode(java.lang.String)">decodeNode</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractReader.html#encodeAttribute(java.lang.String)">encodeAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractReader.html#encodeNode(java.lang.String)">encodeNode</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractReader.html#underlyingReader()">underlyingReader</A></CODE></TD> 314</TR> 315</TABLE> 316 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 317<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 318<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 319<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> 320</TR> 321<TR BGCOLOR="white" CLASS="TableRowColor"> 322<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> 323</TR> 324</TABLE> 325 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.HierarchicalStreamReader"><!-- --></A> 326<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 327<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 328<TH ALIGN="left"><B>Methods inherited from interface com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></B></TH> 329</TR> 330<TR BGCOLOR="white" CLASS="TableRowColor"> 331<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)">appendErrors</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#close()">close</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(int)">getAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeCount()">getAttributeCount</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeName(int)">getAttributeName</A></CODE></TD> 332</TR> 333</TABLE> 334 335<P> 336 337<!-- ============ FIELD DETAIL =========== --> 338 339<A NAME="field_detail"><!-- --></A> 340<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 341<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 342<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 343<B>Field Detail</B></FONT></TH> 344</TR> 345</TABLE> 346 347<A NAME="START_NODE"><!-- --></A><H3> 348START_NODE</H3> 349<PRE> 350protected static final int <B>START_NODE</B></PRE> 351<DL> 352<DL> 353<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.xml.AbstractPullReader.START_NODE">Constant Field Values</A></DL> 354</DL> 355<HR> 356 357<A NAME="END_NODE"><!-- --></A><H3> 358END_NODE</H3> 359<PRE> 360protected static final int <B>END_NODE</B></PRE> 361<DL> 362<DL> 363<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.xml.AbstractPullReader.END_NODE">Constant Field Values</A></DL> 364</DL> 365<HR> 366 367<A NAME="TEXT"><!-- --></A><H3> 368TEXT</H3> 369<PRE> 370protected static final int <B>TEXT</B></PRE> 371<DL> 372<DL> 373<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.xml.AbstractPullReader.TEXT">Constant Field Values</A></DL> 374</DL> 375<HR> 376 377<A NAME="COMMENT"><!-- --></A><H3> 378COMMENT</H3> 379<PRE> 380protected static final int <B>COMMENT</B></PRE> 381<DL> 382<DL> 383<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.xml.AbstractPullReader.COMMENT">Constant Field Values</A></DL> 384</DL> 385<HR> 386 387<A NAME="OTHER"><!-- --></A><H3> 388OTHER</H3> 389<PRE> 390protected static final int <B>OTHER</B></PRE> 391<DL> 392<DL> 393<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.xml.AbstractPullReader.OTHER">Constant Field Values</A></DL> 394</DL> 395 396<!-- ========= CONSTRUCTOR DETAIL ======== --> 397 398<A NAME="constructor_detail"><!-- --></A> 399<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 400<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 401<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 402<B>Constructor Detail</B></FONT></TH> 403</TR> 404</TABLE> 405 406<A NAME="AbstractPullReader(com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 407AbstractPullReader</H3> 408<PRE> 409protected <B>AbstractPullReader</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</PRE> 410<DL> 411<DL> 412<DT><B>Since:</B></DT> 413 <DD>1.4</DD> 414</DL> 415</DL> 416<HR> 417 418<A NAME="AbstractPullReader(com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)"><!-- --></A><H3> 419AbstractPullReader</H3> 420<PRE> 421protected <B>AbstractPullReader</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</PRE> 422<DL> 423<DD><B>Deprecated.</B> <I>As of 1.4 use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#AbstractPullReader(com.thoughtworks.xstream.io.naming.NameCoder)"><CODE>AbstractPullReader(NameCoder)</CODE></A> instead</I> 424<P> 425<DL> 426<DT><B>Since:</B></DT> 427 <DD>1.2</DD> 428</DL> 429</DL> 430 431<!-- ============ METHOD DETAIL ========== --> 432 433<A NAME="method_detail"><!-- --></A> 434<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 435<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 436<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 437<B>Method Detail</B></FONT></TH> 438</TR> 439</TABLE> 440 441<A NAME="pullNextEvent()"><!-- --></A><H3> 442pullNextEvent</H3> 443<PRE> 444protected abstract int <B>pullNextEvent</B>()</PRE> 445<DL> 446<DD>Pull the next event from the stream. 447 448 <p>This MUST return <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#START_NODE"><CODE>START_NODE</CODE></A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#END_NODE"><CODE>END_NODE</CODE></A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#TEXT"><CODE>TEXT</CODE></A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#COMMENT"><CODE>COMMENT</CODE></A>, 449 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#OTHER"><CODE>OTHER</CODE></A> or throw <A HREF="../../../../../com/thoughtworks/xstream/io/StreamException.html" title="class in com.thoughtworks.xstream.io"><CODE>StreamException</CODE></A>.</p> 450 451 <p>The underlying pull parser will most likely return its own event types. These must be 452 mapped to the appropriate events.</p> 453<P> 454<DD><DL> 455</DL> 456</DD> 457</DL> 458<HR> 459 460<A NAME="pullElementName()"><!-- --></A><H3> 461pullElementName</H3> 462<PRE> 463protected abstract <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>pullElementName</B>()</PRE> 464<DL> 465<DD>Pull the name of the current element from the stream. 466<P> 467<DD><DL> 468</DL> 469</DD> 470</DL> 471<HR> 472 473<A NAME="pullText()"><!-- --></A><H3> 474pullText</H3> 475<PRE> 476protected abstract <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>pullText</B>()</PRE> 477<DL> 478<DD>Pull the contents of the current text node from the stream. 479<P> 480<DD><DL> 481</DL> 482</DD> 483</DL> 484<HR> 485 486<A NAME="hasMoreChildren()"><!-- --></A><H3> 487hasMoreChildren</H3> 488<PRE> 489public boolean <B>hasMoreChildren</B>()</PRE> 490<DL> 491<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#hasMoreChildren()">HierarchicalStreamReader</A></CODE></B></DD> 492<DD>Does the node have any more children remaining that have not yet been read? 493<P> 494<DD><DL> 495</DL> 496</DD> 497</DL> 498<HR> 499 500<A NAME="moveDown()"><!-- --></A><H3> 501moveDown</H3> 502<PRE> 503public void <B>moveDown</B>()</PRE> 504<DL> 505<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveDown()">HierarchicalStreamReader</A></CODE></B></DD> 506<DD>Select the current child as current node. 507 A call to this function must be balanced with a call to <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveUp()"><CODE>HierarchicalStreamReader.moveUp()</CODE></A>. 508<P> 509<DD><DL> 510</DL> 511</DD> 512</DL> 513<HR> 514 515<A NAME="moveUp()"><!-- --></A><H3> 516moveUp</H3> 517<PRE> 518public void <B>moveUp</B>()</PRE> 519<DL> 520<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveUp()">HierarchicalStreamReader</A></CODE></B></DD> 521<DD>Select the parent node as current node. 522<P> 523<DD><DL> 524</DL> 525</DD> 526</DL> 527<HR> 528 529<A NAME="mark()"><!-- --></A><H3> 530mark</H3> 531<PRE> 532public void <B>mark</B>()</PRE> 533<DL> 534<DD><DL> 535</DL> 536</DD> 537</DL> 538<HR> 539 540<A NAME="reset()"><!-- --></A><H3> 541reset</H3> 542<PRE> 543public void <B>reset</B>()</PRE> 544<DL> 545<DD><DL> 546</DL> 547</DD> 548</DL> 549<HR> 550 551<A NAME="getValue()"><!-- --></A><H3> 552getValue</H3> 553<PRE> 554public <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> 555<DL> 556<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getValue()">HierarchicalStreamReader</A></CODE></B></DD> 557<DD>Get the value (text content) of the current node. 558<P> 559<DD><DL> 560</DL> 561</DD> 562</DL> 563<HR> 564 565<A NAME="getAttributeNames()"><!-- --></A><H3> 566getAttributeNames</H3> 567<PRE> 568public <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> 569<DL> 570<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeNames()">HierarchicalStreamReader</A></CODE></B></DD> 571<DD>Names of attributes (as Strings). 572<P> 573<DD><DL> 574</DL> 575</DD> 576</DL> 577<HR> 578 579<A NAME="getNodeName()"><!-- --></A><H3> 580getNodeName</H3> 581<PRE> 582public <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> 583<DL> 584<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getNodeName()">HierarchicalStreamReader</A></CODE></B></DD> 585<DD>Get the name of the current node. 586<P> 587<DD><DL> 588</DL> 589</DD> 590</DL> 591<!-- ========= END OF CLASS DATA ========= --> 592<HR> 593 594 595<!-- ======= START OF BOTTOM NAVBAR ====== --> 596<A NAME="navbar_bottom"><!-- --></A> 597<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 598<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 599<TR> 600<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 601<A NAME="navbar_bottom_firstrow"><!-- --></A> 602<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 603 <TR ALIGN="center" VALIGN="top"> 604 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 605 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 606 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 607 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractPullReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 608 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 609 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 610 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 611 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 612 </TR> 613</TABLE> 614</TD> 615<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 616</EM> 617</TD> 618</TR> 619 620<TR> 621<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 622 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractDocumentWriter.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 623 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractXmlDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 624<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 625 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/AbstractPullReader.html" target="_top"><B>FRAMES</B></A> 626 <A HREF="AbstractPullReader.html" target="_top"><B>NO FRAMES</B></A> 627 <SCRIPT type="text/javascript"> 628 <!-- 629 if(window==top) { 630 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 631 } 632 //--> 633</SCRIPT> 634<NOSCRIPT> 635 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 636</NOSCRIPT> 637 638 639</FONT></TD> 640</TR> 641<TR> 642<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 643 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 644<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 645DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 646</TR> 647</TABLE> 648<A NAME="skip-navbar_bottom"></A> 649<!-- ======== END OF BOTTOM NAVBAR ======= --> 650 651<HR> 652Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 653</BODY> 654</HTML>