/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/XppReader.html
HTML | 601 lines | 521 code | 57 blank | 23 comment | 0 complexity | a32aa34b0aa14702a59c8b4c5fceee08 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> 8XppReader (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="XppReader (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/XppReader.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/XppDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XStream11NameCoder.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/XppReader.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XppReader.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="#fields_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractPullReader">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: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.thoughtworks.xstream.io.xml</FONT> 93<BR> 94Class XppReader</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 "><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">com.thoughtworks.xstream.io.xml.AbstractPullReader</A> 100 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.xml.XppReader</B> 101</PRE> 102<DL> 103<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> 104</DL> 105<HR> 106<DL> 107<DT><PRE>public class <B>XppReader</B><DT>extends <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A></DL> 108</PRE> 109 110<P> 111XStream reader that pulls directly from the stream using the XmlPullParser API. 112<P> 113 114<P> 115<DL> 116<DT><B>Author:</B></DT> 117 <DD>Joe Walnes, Jörg Schaible</DD> 118</DL> 119<HR> 120 121<P> 122<!-- =========== FIELD SUMMARY =========== --> 123 124<A NAME="field_summary"><!-- --></A> 125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 127<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 128<B>Field Summary</B></FONT></TH> 129</TR> 130</TABLE> 131 <A NAME="fields_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractPullReader"><!-- --></A> 132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 133<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 134<TH ALIGN="left"><B>Fields inherited from class com.thoughtworks.xstream.io.xml.<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A></B></TH> 135</TR> 136<TR BGCOLOR="white" CLASS="TableRowColor"> 137<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#COMMENT">COMMENT</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#END_NODE">END_NODE</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#OTHER">OTHER</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#START_NODE">START_NODE</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#TEXT">TEXT</A></CODE></TD> 138</TR> 139</TABLE> 140 141<!-- ======== CONSTRUCTOR SUMMARY ======== --> 142 143<A NAME="constructor_summary"><!-- --></A> 144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 147<B>Constructor Summary</B></FONT></TH> 148</TR> 149<TR BGCOLOR="white" CLASS="TableRowColor"> 150<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader)">XppReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader)</CODE> 151 152<BR> 153 <B>Deprecated.</B> <I>As of 1.4, use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser)"><CODE>XppReader(Reader, XmlPullParser)</CODE></A> instead</I></TD> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)">XppReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, 157 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</CODE> 158 159<BR> 160 <B>Deprecated.</B> <I>As of 1.4, use <CODE>#XppReader(Reader, XmlPullParser, XmlFriendlyReplacer)</CODE> instead</I></TD> 161</TR> 162<TR BGCOLOR="white" CLASS="TableRowColor"> 163<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser)">XppReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, 164 org.xmlpull.v1.XmlPullParser parser)</CODE> 165 166<BR> 167 Construct an XppReader.</TD> 168</TR> 169<TR BGCOLOR="white" CLASS="TableRowColor"> 170<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser, com.thoughtworks.xstream.io.naming.NameCoder)">XppReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, 171 org.xmlpull.v1.XmlPullParser parser, 172 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 173 174<BR> 175 Construct an XppReader.</TD> 176</TR> 177</TABLE> 178 179<!-- ========== METHOD SUMMARY =========== --> 180 181<A NAME="method_summary"><!-- --></A> 182<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 183<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 184<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 185<B>Method Summary</B></FONT></TH> 186</TR> 187<TR BGCOLOR="white" CLASS="TableRowColor"> 188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 189<CODE> void</CODE></FONT></TD> 190<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.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> errorWriter)</CODE> 191 192<BR> 193 If any errors are detected, allow the reader to add any additional information that can aid debugging 194 (such as line numbers, XPath expressions, etc).</TD> 195</TR> 196<TR BGCOLOR="white" CLASS="TableRowColor"> 197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 198<CODE> void</CODE></FONT></TD> 199<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#close()">close</A></B>()</CODE> 200 201<BR> 202 Close the reader, if necessary.</TD> 203</TR> 204<TR BGCOLOR="white" CLASS="TableRowColor"> 205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 206<CODE>protected org.xmlpull.v1.XmlPullParser</CODE></FONT></TD> 207<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#createParser()">createParser</A></B>()</CODE> 208 209<BR> 210 <B>Deprecated.</B> <I>As of 1.4, use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser)"><CODE>XppReader(Reader, XmlPullParser)</CODE></A> instead</I></TD> 211</TR> 212<TR BGCOLOR="white" CLASS="TableRowColor"> 213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 214<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 215<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#getAttribute(int)">getAttribute</A></B>(int index)</CODE> 216 217<BR> 218 Get the value of an attribute of the current node, by index.</TD> 219</TR> 220<TR BGCOLOR="white" CLASS="TableRowColor"> 221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 222<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> 223<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.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> name)</CODE> 224 225<BR> 226 Get the value of an attribute of the current node.</TD> 227</TR> 228<TR BGCOLOR="white" CLASS="TableRowColor"> 229<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 230<CODE> int</CODE></FONT></TD> 231<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#getAttributeCount()">getAttributeCount</A></B>()</CODE> 232 233<BR> 234 Number of attributes in current node.</TD> 235</TR> 236<TR BGCOLOR="white" CLASS="TableRowColor"> 237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 238<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> 239<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#getAttributeName(int)">getAttributeName</A></B>(int index)</CODE> 240 241<BR> 242 Name of attribute in current node.</TD> 243</TR> 244<TR BGCOLOR="white" CLASS="TableRowColor"> 245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 246<CODE>protected <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> 247<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#pullElementName()">pullElementName</A></B>()</CODE> 248 249<BR> 250 Pull the name of the current element from the stream.</TD> 251</TR> 252<TR BGCOLOR="white" CLASS="TableRowColor"> 253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 254<CODE>protected int</CODE></FONT></TD> 255<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#pullNextEvent()">pullNextEvent</A></B>()</CODE> 256 257<BR> 258 Pull the next event from the stream.</TD> 259</TR> 260<TR BGCOLOR="white" CLASS="TableRowColor"> 261<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 262<CODE>protected <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> 263<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#pullText()">pullText</A></B>()</CODE> 264 265<BR> 266 Pull the contents of the current text node from the stream.</TD> 267</TR> 268</TABLE> 269 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractPullReader"><!-- --></A> 270<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 271<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 272<TH ALIGN="left"><B>Methods inherited from class com.thoughtworks.xstream.io.xml.<A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A></B></TH> 273</TR> 274<TR BGCOLOR="white" CLASS="TableRowColor"> 275<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#getAttributeNames()">getAttributeNames</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#getNodeName()">getNodeName</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#getValue()">getValue</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#hasMoreChildren()">hasMoreChildren</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#mark()">mark</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#moveDown()">moveDown</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#moveUp()">moveUp</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#reset()">reset</A></CODE></TD> 276</TR> 277</TABLE> 278 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractXmlReader"><!-- --></A> 279<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 280<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 281<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> 282</TR> 283<TR BGCOLOR="white" CLASS="TableRowColor"> 284<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> 285</TR> 286</TABLE> 287 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.AbstractReader"><!-- --></A> 288<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 289<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 290<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> 291</TR> 292<TR BGCOLOR="white" CLASS="TableRowColor"> 293<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> 294</TR> 295</TABLE> 296 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 298<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 299<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> 300</TR> 301<TR BGCOLOR="white" CLASS="TableRowColor"> 302<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> 303</TR> 304</TABLE> 305 306<P> 307 308<!-- ========= CONSTRUCTOR DETAIL ======== --> 309 310<A NAME="constructor_detail"><!-- --></A> 311<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 312<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 313<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 314<B>Constructor Detail</B></FONT></TH> 315</TR> 316</TABLE> 317 318<A NAME="XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser)"><!-- --></A><H3> 319XppReader</H3> 320<PRE> 321public <B>XppReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, 322 org.xmlpull.v1.XmlPullParser parser)</PRE> 323<DL> 324<DD>Construct an XppReader. 325<P> 326<DL> 327<DT><B>Parameters:</B><DD><CODE>reader</CODE> - the reader with the input data<DD><CODE>parser</CODE> - the XPP parser to use<DT><B>Since:</B></DT> 328 <DD>1.4</DD> 329</DL> 330</DL> 331<HR> 332 333<A NAME="XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser, com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 334XppReader</H3> 335<PRE> 336public <B>XppReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, 337 org.xmlpull.v1.XmlPullParser parser, 338 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</PRE> 339<DL> 340<DD>Construct an XppReader. 341<P> 342<DL> 343<DT><B>Parameters:</B><DD><CODE>reader</CODE> - the reader with the input data<DD><CODE>parser</CODE> - the XPP parser to use<DD><CODE>nameCoder</CODE> - the coder for XML friendly tag and attribute names<DT><B>Since:</B></DT> 344 <DD>1.4</DD> 345</DL> 346</DL> 347<HR> 348 349<A NAME="XppReader(java.io.Reader)"><!-- --></A><H3> 350XppReader</H3> 351<PRE> 352public <B>XppReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader)</PRE> 353<DL> 354<DD><B>Deprecated.</B> <I>As of 1.4, use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser)"><CODE>XppReader(Reader, XmlPullParser)</CODE></A> instead</I> 355<P> 356</DL> 357<HR> 358 359<A NAME="XppReader(java.io.Reader, com.thoughtworks.xstream.io.xml.XmlFriendlyReplacer)"><!-- --></A><H3> 360XppReader</H3> 361<PRE> 362public <B>XppReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> reader, 363 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XmlFriendlyReplacer.html" title="class in com.thoughtworks.xstream.io.xml">XmlFriendlyReplacer</A> replacer)</PRE> 364<DL> 365<DD><B>Deprecated.</B> <I>As of 1.4, use <CODE>#XppReader(Reader, XmlPullParser, XmlFriendlyReplacer)</CODE> instead</I> 366<P> 367<DL> 368<DT><B>Since:</B></DT> 369 <DD>1.2</DD> 370</DL> 371</DL> 372 373<!-- ============ METHOD DETAIL ========== --> 374 375<A NAME="method_detail"><!-- --></A> 376<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 377<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 378<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 379<B>Method Detail</B></FONT></TH> 380</TR> 381</TABLE> 382 383<A NAME="createParser()"><!-- --></A><H3> 384createParser</H3> 385<PRE> 386protected org.xmlpull.v1.XmlPullParser <B>createParser</B>()</PRE> 387<DL> 388<DD><B>Deprecated.</B> <I>As of 1.4, use <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppReader.html#XppReader(java.io.Reader, org.xmlpull.v1.XmlPullParser)"><CODE>XppReader(Reader, XmlPullParser)</CODE></A> instead</I> 389<P> 390<DD>To use another implementation of org.xmlpull.v1.XmlPullParser, override this method. 391<P> 392<DD><DL> 393</DL> 394</DD> 395</DL> 396<HR> 397 398<A NAME="pullNextEvent()"><!-- --></A><H3> 399pullNextEvent</H3> 400<PRE> 401protected int <B>pullNextEvent</B>()</PRE> 402<DL> 403<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullNextEvent()">AbstractPullReader</A></CODE></B></DD> 404<DD>Pull the next event from the stream. 405 406 <p>This MUST return <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#START_NODE"><CODE>AbstractPullReader.START_NODE</CODE></A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#END_NODE"><CODE>AbstractPullReader.END_NODE</CODE></A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#TEXT"><CODE>AbstractPullReader.TEXT</CODE></A>, <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#COMMENT"><CODE>AbstractPullReader.COMMENT</CODE></A>, 407 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#OTHER"><CODE>AbstractPullReader.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> 408 409 <p>The underlying pull parser will most likely return its own event types. These must be 410 mapped to the appropriate events.</p> 411<P> 412<DD><DL> 413<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullNextEvent()">pullNextEvent</A></CODE> in class <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A></CODE></DL> 414</DD> 415<DD><DL> 416</DL> 417</DD> 418</DL> 419<HR> 420 421<A NAME="pullElementName()"><!-- --></A><H3> 422pullElementName</H3> 423<PRE> 424protected <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> 425<DL> 426<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullElementName()">AbstractPullReader</A></CODE></B></DD> 427<DD>Pull the name of the current element from the stream. 428<P> 429<DD><DL> 430<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullElementName()">pullElementName</A></CODE> in class <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A></CODE></DL> 431</DD> 432<DD><DL> 433</DL> 434</DD> 435</DL> 436<HR> 437 438<A NAME="pullText()"><!-- --></A><H3> 439pullText</H3> 440<PRE> 441protected <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> 442<DL> 443<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullText()">AbstractPullReader</A></CODE></B></DD> 444<DD>Pull the contents of the current text node from the stream. 445<P> 446<DD><DL> 447<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html#pullText()">pullText</A></CODE> in class <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/xml/AbstractPullReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractPullReader</A></CODE></DL> 448</DD> 449<DD><DL> 450</DL> 451</DD> 452</DL> 453<HR> 454 455<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3> 456getAttribute</H3> 457<PRE> 458public <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> name)</PRE> 459<DL> 460<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(java.lang.String)">HierarchicalStreamReader</A></CODE></B></DD> 461<DD>Get the value of an attribute of the current node. 462<P> 463<DD><DL> 464</DL> 465</DD> 466</DL> 467<HR> 468 469<A NAME="getAttribute(int)"><!-- --></A><H3> 470getAttribute</H3> 471<PRE> 472public <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 index)</PRE> 473<DL> 474<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttribute(int)">HierarchicalStreamReader</A></CODE></B></DD> 475<DD>Get the value of an attribute of the current node, by index. 476<P> 477<DD><DL> 478</DL> 479</DD> 480</DL> 481<HR> 482 483<A NAME="getAttributeCount()"><!-- --></A><H3> 484getAttributeCount</H3> 485<PRE> 486public int <B>getAttributeCount</B>()</PRE> 487<DL> 488<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeCount()">HierarchicalStreamReader</A></CODE></B></DD> 489<DD>Number of attributes in current node. 490<P> 491<DD><DL> 492</DL> 493</DD> 494</DL> 495<HR> 496 497<A NAME="getAttributeName(int)"><!-- --></A><H3> 498getAttributeName</H3> 499<PRE> 500public <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 index)</PRE> 501<DL> 502<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeName(int)">HierarchicalStreamReader</A></CODE></B></DD> 503<DD>Name of attribute in current node. 504<P> 505<DD><DL> 506</DL> 507</DD> 508</DL> 509<HR> 510 511<A NAME="appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)"><!-- --></A><H3> 512appendErrors</H3> 513<PRE> 514public void <B>appendErrors</B>(<A HREF="../../../../../com/thoughtworks/xstream/converters/ErrorWriter.html" title="interface in com.thoughtworks.xstream.converters">ErrorWriter</A> errorWriter)</PRE> 515<DL> 516<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#appendErrors(com.thoughtworks.xstream.converters.ErrorWriter)">HierarchicalStreamReader</A></CODE></B></DD> 517<DD>If any errors are detected, allow the reader to add any additional information that can aid debugging 518 (such as line numbers, XPath expressions, etc). 519<P> 520<DD><DL> 521<DT><B>Parameters:</B><DD><CODE>errorWriter</CODE> - the error writer</DL> 522</DD> 523</DL> 524<HR> 525 526<A NAME="close()"><!-- --></A><H3> 527close</H3> 528<PRE> 529public void <B>close</B>()</PRE> 530<DL> 531<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#close()">HierarchicalStreamReader</A></CODE></B></DD> 532<DD>Close the reader, if necessary. 533<P> 534<DD><DL> 535</DL> 536</DD> 537</DL> 538<!-- ========= END OF CLASS DATA ========= --> 539<HR> 540 541 542<!-- ======= START OF BOTTOM NAVBAR ====== --> 543<A NAME="navbar_bottom"><!-- --></A> 544<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 545<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 546<TR> 547<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 548<A NAME="navbar_bottom_firstrow"><!-- --></A> 549<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 550 <TR ALIGN="center" VALIGN="top"> 551 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 552 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 553 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 554 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XppReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 555 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 556 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 557 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 558 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 559 </TR> 560</TABLE> 561</TD> 562<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 563</EM> 564</TD> 565</TR> 566 567<TR> 568<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 569 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XppDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 570 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/XStream11NameCoder.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 571<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 572 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/XppReader.html" target="_top"><B>FRAMES</B></A> 573 <A HREF="XppReader.html" target="_top"><B>NO FRAMES</B></A> 574 <SCRIPT type="text/javascript"> 575 <!-- 576 if(window==top) { 577 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 578 } 579 //--> 580</SCRIPT> 581<NOSCRIPT> 582 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 583</NOSCRIPT> 584 585 586</FONT></TD> 587</TR> 588<TR> 589<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 590 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_com.thoughtworks.xstream.io.xml.AbstractPullReader">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 591<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 592DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 593</TR> 594</TABLE> 595<A NAME="skip-navbar_bottom"></A> 596<!-- ======== END OF BOTTOM NAVBAR ======= --> 597 598<HR> 599Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 600</BODY> 601</HTML>