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

http://prototipomemoria.googlecode.com/ · HTML · 438 lines · 371 code · 45 blank · 22 comment · 0 complexity · f389df32c1cf9c75f7e6673ed0eaabec MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:24 CEST 2011 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <TITLE>
  8. AbstractReader (XStream Core 1.4.1 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2011-08-11">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="AbstractReader (XStream Core 1.4.1 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/AbstractDriver.html" title="class in com.thoughtworks.xstream.io"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../index.html?com/thoughtworks/xstream/io/AbstractReader.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="AbstractReader.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. com.thoughtworks.xstream.io</FONT>
  82. <BR>
  83. Class AbstractReader</H2>
  84. <PRE>
  85. <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  86. <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.AbstractReader</B>
  87. </PRE>
  88. <DL>
  89. <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>
  90. </DL>
  91. <DL>
  92. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/thoughtworks/xstream/io/xml/AbstractXmlReader.html" title="class in com.thoughtworks.xstream.io.xml">AbstractXmlReader</A></DD>
  93. </DL>
  94. <HR>
  95. <DL>
  96. <DT><PRE>public abstract class <B>AbstractReader</B><DT>extends <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><DT>implements <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></DL>
  97. </PRE>
  98. <P>
  99. Abstract base class for all HierarchicalStreamReader implementations. Implementations of
  100. <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io"><CODE>HierarchicalStreamReader</CODE></A> should rather be derived from this class then implementing
  101. the interface directly.
  102. <P>
  103. <P>
  104. <DL>
  105. <DT><B>Since:</B></DT>
  106. <DD>1.4</DD>
  107. <DT><B>Author:</B></DT>
  108. <DD>J&ouml;rg Schaible</DD>
  109. </DL>
  110. <HR>
  111. <P>
  112. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  113. <A NAME="constructor_summary"><!-- --></A>
  114. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  115. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  116. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  117. <B>Constructor Summary</B></FONT></TH>
  118. </TR>
  119. <TR BGCOLOR="white" CLASS="TableRowColor">
  120. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  121. <CODE>protected </CODE></FONT></TD>
  122. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#AbstractReader()">AbstractReader</A></B>()</CODE>
  123. <BR>
  124. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an AbstractReader with a NameCoder that does nothing.</TD>
  125. </TR>
  126. <TR BGCOLOR="white" CLASS="TableRowColor">
  127. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  128. <CODE>protected </CODE></FONT></TD>
  129. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#AbstractReader(com.thoughtworks.xstream.io.naming.NameCoder)">AbstractReader</A></B>(<A HREF="../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A>&nbsp;nameCoder)</CODE>
  130. <BR>
  131. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an AbstractReader with a provided <A HREF="../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming"><CODE>NameCoder</CODE></A>.</TD>
  132. </TR>
  133. </TABLE>
  134. &nbsp;
  135. <!-- ========== METHOD SUMMARY =========== -->
  136. <A NAME="method_summary"><!-- --></A>
  137. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  138. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  139. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  140. <B>Method Summary</B></FONT></TH>
  141. </TR>
  142. <TR BGCOLOR="white" CLASS="TableRowColor">
  143. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  144. <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>
  145. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#decodeAttribute(java.lang.String)">decodeAttribute</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>
  146. <BR>
  147. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode an attribute name from the target format.</TD>
  148. </TR>
  149. <TR BGCOLOR="white" CLASS="TableRowColor">
  150. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  151. <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>
  152. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#decodeNode(java.lang.String)">decodeNode</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>
  153. <BR>
  154. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode a node name from the target format.</TD>
  155. </TR>
  156. <TR BGCOLOR="white" CLASS="TableRowColor">
  157. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  158. <CODE>protected &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>
  159. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#encodeAttribute(java.lang.String)">encodeAttribute</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>
  160. <BR>
  161. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encode the attribute name again into the name of the target format.</TD>
  162. </TR>
  163. <TR BGCOLOR="white" CLASS="TableRowColor">
  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  165. <CODE>protected &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>
  166. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#encodeNode(java.lang.String)">encodeNode</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>
  167. <BR>
  168. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Encode the node name again into the name of the target format.</TD>
  169. </TR>
  170. <TR BGCOLOR="white" CLASS="TableRowColor">
  171. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  172. <CODE>&nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></CODE></FONT></TD>
  173. <TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/io/AbstractReader.html#underlyingReader()">underlyingReader</A></B>()</CODE>
  174. <BR>
  175. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the underlying HierarchicalStreamReader implementation.</TD>
  176. </TR>
  177. </TABLE>
  178. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  179. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  180. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  181. <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>
  182. </TR>
  183. <TR BGCOLOR="white" CLASS="TableRowColor">
  184. <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>
  185. </TR>
  186. </TABLE>
  187. &nbsp;<A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.HierarchicalStreamReader"><!-- --></A>
  188. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  189. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  190. <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>
  191. </TR>
  192. <TR BGCOLOR="white" CLASS="TableRowColor">
  193. <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>, <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getAttributeNames()">getAttributeNames</A>, <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getNodeName()">getNodeName</A>, <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#getValue()">getValue</A>, <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#hasMoreChildren()">hasMoreChildren</A>, <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveDown()">moveDown</A>, <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#moveUp()">moveUp</A></CODE></TD>
  194. </TR>
  195. </TABLE>
  196. &nbsp;
  197. <P>
  198. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  199. <A NAME="constructor_detail"><!-- --></A>
  200. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  201. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  202. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  203. <B>Constructor Detail</B></FONT></TH>
  204. </TR>
  205. </TABLE>
  206. <A NAME="AbstractReader()"><!-- --></A><H3>
  207. AbstractReader</H3>
  208. <PRE>
  209. protected <B>AbstractReader</B>()</PRE>
  210. <DL>
  211. <DD>Creates an AbstractReader with a NameCoder that does nothing.
  212. <P>
  213. <DL>
  214. <DT><B>Since:</B></DT>
  215. <DD>1.4</DD>
  216. </DL>
  217. </DL>
  218. <HR>
  219. <A NAME="AbstractReader(com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3>
  220. AbstractReader</H3>
  221. <PRE>
  222. protected <B>AbstractReader</B>(<A HREF="../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A>&nbsp;nameCoder)</PRE>
  223. <DL>
  224. <DD>Creates an AbstractReader with a provided <A HREF="../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming"><CODE>NameCoder</CODE></A>.
  225. <P>
  226. <DL>
  227. <DT><B>Parameters:</B><DD><CODE>nameCoder</CODE> - the name coder used to read names from the incoming format<DT><B>Since:</B></DT>
  228. <DD>1.4</DD>
  229. </DL>
  230. </DL>
  231. <!-- ============ METHOD DETAIL ========== -->
  232. <A NAME="method_detail"><!-- --></A>
  233. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  234. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  235. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  236. <B>Method Detail</B></FONT></TH>
  237. </TR>
  238. </TABLE>
  239. <A NAME="underlyingReader()"><!-- --></A><H3>
  240. underlyingReader</H3>
  241. <PRE>
  242. public <A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A> <B>underlyingReader</B>()</PRE>
  243. <DL>
  244. <DD>Return the underlying HierarchicalStreamReader implementation.
  245. <p>If a Converter needs to access methods of a specific HierarchicalStreamReader implementation that are not
  246. defined in the HierarchicalStreamReader interface, it should call this method before casting. This is because
  247. the reader passed to the Converter is often wrapped/decorated by another implementation to provide additional
  248. functionality (such as XPath tracking).</p>
  249. <p>For example:</p>
  250. <pre>MySpecificReader mySpecificReader = (MySpecificReader)reader; <b>// INCORRECT!</b>
  251. mySpecificReader.doSomethingSpecific();</pre>
  252. <pre>MySpecificReader mySpecificReader = (MySpecificReader)reader.underlyingReader(); <b>// CORRECT!</b>
  253. mySpecificReader.doSomethingSpecific();</pre>
  254. <p>Implementations of HierarchicalStreamReader should return 'this', unless they are a decorator, in which case
  255. they should delegate to whatever they are wrapping.</p>
  256. <P>
  257. <DD><DL>
  258. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html#underlyingReader()">underlyingReader</A></CODE> in interface <CODE><A HREF="../../../../com/thoughtworks/xstream/io/HierarchicalStreamReader.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamReader</A></CODE></DL>
  259. </DD>
  260. <DD><DL>
  261. </DL>
  262. </DD>
  263. </DL>
  264. <HR>
  265. <A NAME="decodeNode(java.lang.String)"><!-- --></A><H3>
  266. decodeNode</H3>
  267. <PRE>
  268. public <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>decodeNode</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>
  269. <DL>
  270. <DD>Decode a node name from the target format.
  271. <P>
  272. <DD><DL>
  273. </DL>
  274. </DD>
  275. <DD><DL>
  276. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name in the target format
  277. <DT><B>Returns:</B><DD>the original name<DT><B>Since:</B></DT>
  278. <DD>1.4</DD>
  279. </DL>
  280. </DD>
  281. </DL>
  282. <HR>
  283. <A NAME="decodeAttribute(java.lang.String)"><!-- --></A><H3>
  284. decodeAttribute</H3>
  285. <PRE>
  286. public <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>decodeAttribute</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>
  287. <DL>
  288. <DD>Decode an attribute name from the target format.
  289. <P>
  290. <DD><DL>
  291. </DL>
  292. </DD>
  293. <DD><DL>
  294. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name in the target format
  295. <DT><B>Returns:</B><DD>the original name<DT><B>Since:</B></DT>
  296. <DD>1.4</DD>
  297. </DL>
  298. </DD>
  299. </DL>
  300. <HR>
  301. <A NAME="encodeNode(java.lang.String)"><!-- --></A><H3>
  302. encodeNode</H3>
  303. <PRE>
  304. 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> <B>encodeNode</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>
  305. <DL>
  306. <DD>Encode the node name again into the name of the target format. Internally used.
  307. <P>
  308. <DD><DL>
  309. </DL>
  310. </DD>
  311. <DD><DL>
  312. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the original name
  313. <DT><B>Returns:</B><DD>the name in the target format<DT><B>Since:</B></DT>
  314. <DD>1.4</DD>
  315. </DL>
  316. </DD>
  317. </DL>
  318. <HR>
  319. <A NAME="encodeAttribute(java.lang.String)"><!-- --></A><H3>
  320. encodeAttribute</H3>
  321. <PRE>
  322. 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> <B>encodeAttribute</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>
  323. <DL>
  324. <DD>Encode the attribute name again into the name of the target format. Internally used.
  325. <P>
  326. <DD><DL>
  327. </DL>
  328. </DD>
  329. <DD><DL>
  330. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the original name
  331. <DT><B>Returns:</B><DD>the name in the target format<DT><B>Since:</B></DT>
  332. <DD>1.4</DD>
  333. </DL>
  334. </DD>
  335. </DL>
  336. <!-- ========= END OF CLASS DATA ========= -->
  337. <HR>
  338. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  339. <A NAME="navbar_bottom"><!-- --></A>
  340. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  341. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  342. <TR>
  343. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  344. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  345. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  346. <TR ALIGN="center" VALIGN="top">
  347. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  348. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  349. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  350. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  351. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  352. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  353. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  354. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  355. </TR>
  356. </TABLE>
  357. </TD>
  358. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  359. </EM>
  360. </TD>
  361. </TR>
  362. <TR>
  363. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  364. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/AbstractDriver.html" title="class in com.thoughtworks.xstream.io"><B>PREV CLASS</B></A>&nbsp;
  365. &nbsp;<A HREF="../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io"><B>NEXT CLASS</B></A></FONT></TD>
  366. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  367. <A HREF="../../../../index.html?com/thoughtworks/xstream/io/AbstractReader.html" target="_top"><B>FRAMES</B></A> &nbsp;
  368. &nbsp;<A HREF="AbstractReader.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  369. &nbsp;<SCRIPT type="text/javascript">
  370. <!--
  371. if(window==top) {
  372. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  373. }
  374. //-->
  375. </SCRIPT>
  376. <NOSCRIPT>
  377. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  378. </NOSCRIPT>
  379. </FONT></TD>
  380. </TR>
  381. <TR>
  382. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  383. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  384. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  385. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  386. </TR>
  387. </TABLE>
  388. <A NAME="skip-navbar_bottom"></A>
  389. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  390. <HR>
  391. Copyright &#169; 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved.
  392. </BODY>
  393. </HTML>