ProxyReader.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  7. <title>ProxyReader (Apache Commons IO 2.6 API)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="ProxyReader (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/ProxyReader.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../../index.html?org/apache/commons/io/input/ProxyReader.html" target="_top">Frames</a></li>
  57. <li><a href="ProxyReader.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#fields.inherited.from.class.java.io.FilterReader">Field</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io.input</div>
  96. <h2 title="Class ProxyReader" class="title">Class ProxyReader</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">java.io.Reader</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">java.io.FilterReader</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li>org.apache.commons.io.input.ProxyReader</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <dl>
  121. <dt>All Implemented Interfaces:</dt>
  122. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Readable.html?is-external=true" title="class or interface in java.lang">Readable</a></dd>
  123. </dl>
  124. <hr>
  125. <br>
  126. <pre>public abstract class <span class="typeNameLabel">ProxyReader</span>
  127. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></pre>
  128. <div class="block">A Proxy stream which acts as expected, that is it passes the method
  129. calls on to the proxied stream and doesn't change which methods are
  130. being called.
  131. <p>
  132. It is an alternative base class to FilterReader
  133. to increase reusability, because FilterReader changes the
  134. methods being called, such as read(char[]) to read(char[], int, int).</div>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="summary">
  139. <ul class="blockList">
  140. <li class="blockList">
  141. <!-- =========== FIELD SUMMARY =========== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="field.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Field Summary</h3>
  147. <ul class="blockList">
  148. <li class="blockList"><a name="fields.inherited.from.class.java.io.FilterReader">
  149. <!-- -->
  150. </a>
  151. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></h3>
  152. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#in" title="class or interface in java.io">in</a></code></li>
  153. </ul>
  154. <ul class="blockList">
  155. <li class="blockList"><a name="fields.inherited.from.class.java.io.Reader">
  156. <!-- -->
  157. </a>
  158. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></h3>
  159. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#lock" title="class or interface in java.io">lock</a></code></li>
  160. </ul>
  161. </li>
  162. </ul>
  163. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  164. <ul class="blockList">
  165. <li class="blockList"><a name="constructor.summary">
  166. <!-- -->
  167. </a>
  168. <h3>Constructor Summary</h3>
  169. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  170. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  171. <tr>
  172. <th class="colOne" scope="col">Constructor and Description</th>
  173. </tr>
  174. <tr class="altColor">
  175. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#ProxyReader-java.io.Reader-">ProxyReader</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;proxy)</code>
  176. <div class="block">Constructs a new ProxyReader.</div>
  177. </td>
  178. </tr>
  179. </table>
  180. </li>
  181. </ul>
  182. <!-- ========== METHOD SUMMARY =========== -->
  183. <ul class="blockList">
  184. <li class="blockList"><a name="method.summary">
  185. <!-- -->
  186. </a>
  187. <h3>Method Summary</h3>
  188. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  189. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  190. <tr>
  191. <th class="colFirst" scope="col">Modifier and Type</th>
  192. <th class="colLast" scope="col">Method and Description</th>
  193. </tr>
  194. <tr id="i0" class="altColor">
  195. <td class="colFirst"><code>protected void</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#afterRead-int-">afterRead</a></span>(int&nbsp;n)</code>
  197. <div class="block">Invoked by the read methods after the proxied call has returned
  198. successfully.</div>
  199. </td>
  200. </tr>
  201. <tr id="i1" class="rowColor">
  202. <td class="colFirst"><code>protected void</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#beforeRead-int-">beforeRead</a></span>(int&nbsp;n)</code>
  204. <div class="block">Invoked by the read methods before the call is proxied.</div>
  205. </td>
  206. </tr>
  207. <tr id="i2" class="altColor">
  208. <td class="colFirst"><code>void</code></td>
  209. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#close--">close</a></span>()</code>
  210. <div class="block">Invokes the delegate's <code>close()</code> method.</div>
  211. </td>
  212. </tr>
  213. <tr id="i3" class="rowColor">
  214. <td class="colFirst"><code>protected void</code></td>
  215. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#handleIOException-java.io.IOException-">handleIOException</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;e)</code>
  216. <div class="block">Handle any IOExceptions thrown.</div>
  217. </td>
  218. </tr>
  219. <tr id="i4" class="altColor">
  220. <td class="colFirst"><code>void</code></td>
  221. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#mark-int-">mark</a></span>(int&nbsp;idx)</code>
  222. <div class="block">Invokes the delegate's <code>mark(int)</code> method.</div>
  223. </td>
  224. </tr>
  225. <tr id="i5" class="rowColor">
  226. <td class="colFirst"><code>boolean</code></td>
  227. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#markSupported--">markSupported</a></span>()</code>
  228. <div class="block">Invokes the delegate's <code>markSupported()</code> method.</div>
  229. </td>
  230. </tr>
  231. <tr id="i6" class="altColor">
  232. <td class="colFirst"><code>int</code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#read--">read</a></span>()</code>
  234. <div class="block">Invokes the delegate's <code>read()</code> method.</div>
  235. </td>
  236. </tr>
  237. <tr id="i7" class="rowColor">
  238. <td class="colFirst"><code>int</code></td>
  239. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#read-char:A-">read</a></span>(char[]&nbsp;chr)</code>
  240. <div class="block">Invokes the delegate's <code>read(char[])</code> method.</div>
  241. </td>
  242. </tr>
  243. <tr id="i8" class="altColor">
  244. <td class="colFirst"><code>int</code></td>
  245. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#read-char:A-int-int-">read</a></span>(char[]&nbsp;chr,
  246. int&nbsp;st,
  247. int&nbsp;len)</code>
  248. <div class="block">Invokes the delegate's <code>read(char[], int, int)</code> method.</div>
  249. </td>
  250. </tr>
  251. <tr id="i9" class="rowColor">
  252. <td class="colFirst"><code>int</code></td>
  253. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#read-java.nio.CharBuffer-">read</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/CharBuffer.html?is-external=true" title="class or interface in java.nio">CharBuffer</a>&nbsp;target)</code>
  254. <div class="block">Invokes the delegate's <code>read(CharBuffer)</code> method.</div>
  255. </td>
  256. </tr>
  257. <tr id="i10" class="altColor">
  258. <td class="colFirst"><code>boolean</code></td>
  259. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#ready--">ready</a></span>()</code>
  260. <div class="block">Invokes the delegate's <code>ready()</code> method.</div>
  261. </td>
  262. </tr>
  263. <tr id="i11" class="rowColor">
  264. <td class="colFirst"><code>void</code></td>
  265. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#reset--">reset</a></span>()</code>
  266. <div class="block">Invokes the delegate's <code>reset()</code> method.</div>
  267. </td>
  268. </tr>
  269. <tr id="i12" class="altColor">
  270. <td class="colFirst"><code>long</code></td>
  271. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html#skip-long-">skip</a></span>(long&nbsp;ln)</code>
  272. <div class="block">Invokes the delegate's <code>skip(long)</code> method.</div>
  273. </td>
  274. </tr>
  275. </table>
  276. <ul class="blockList">
  277. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  278. <!-- -->
  279. </a>
  280. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  281. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/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://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </li>
  286. </ul>
  287. </div>
  288. <div class="details">
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  292. <ul class="blockList">
  293. <li class="blockList"><a name="constructor.detail">
  294. <!-- -->
  295. </a>
  296. <h3>Constructor Detail</h3>
  297. <a name="ProxyReader-java.io.Reader-">
  298. <!-- -->
  299. </a>
  300. <ul class="blockListLast">
  301. <li class="blockList">
  302. <h4>ProxyReader</h4>
  303. <pre>public&nbsp;ProxyReader(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;proxy)</pre>
  304. <div class="block">Constructs a new ProxyReader.</div>
  305. <dl>
  306. <dt><span class="paramLabel">Parameters:</span></dt>
  307. <dd><code>proxy</code> - the Reader to delegate to</dd>
  308. </dl>
  309. </li>
  310. </ul>
  311. </li>
  312. </ul>
  313. <!-- ============ METHOD DETAIL ========== -->
  314. <ul class="blockList">
  315. <li class="blockList"><a name="method.detail">
  316. <!-- -->
  317. </a>
  318. <h3>Method Detail</h3>
  319. <a name="read--">
  320. <!-- -->
  321. </a>
  322. <ul class="blockList">
  323. <li class="blockList">
  324. <h4>read</h4>
  325. <pre>public&nbsp;int&nbsp;read()
  326. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  327. <div class="block">Invokes the delegate's <code>read()</code> method.</div>
  328. <dl>
  329. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  330. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#read--" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  331. <dt><span class="returnLabel">Returns:</span></dt>
  332. <dd>the character read or -1 if the end of stream</dd>
  333. <dt><span class="throwsLabel">Throws:</span></dt>
  334. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  335. </dl>
  336. </li>
  337. </ul>
  338. <a name="read-char:A-">
  339. <!-- -->
  340. </a>
  341. <ul class="blockList">
  342. <li class="blockList">
  343. <h4>read</h4>
  344. <pre>public&nbsp;int&nbsp;read(char[]&nbsp;chr)
  345. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  346. <div class="block">Invokes the delegate's <code>read(char[])</code> method.</div>
  347. <dl>
  348. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  349. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#read-char:A-" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  350. <dt><span class="paramLabel">Parameters:</span></dt>
  351. <dd><code>chr</code> - the buffer to read the characters into</dd>
  352. <dt><span class="returnLabel">Returns:</span></dt>
  353. <dd>the number of characters read or -1 if the end of stream</dd>
  354. <dt><span class="throwsLabel">Throws:</span></dt>
  355. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  356. </dl>
  357. </li>
  358. </ul>
  359. <a name="read-char:A-int-int-">
  360. <!-- -->
  361. </a>
  362. <ul class="blockList">
  363. <li class="blockList">
  364. <h4>read</h4>
  365. <pre>public&nbsp;int&nbsp;read(char[]&nbsp;chr,
  366. int&nbsp;st,
  367. int&nbsp;len)
  368. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  369. <div class="block">Invokes the delegate's <code>read(char[], int, int)</code> method.</div>
  370. <dl>
  371. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  372. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#read-char:A-int-int-" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  373. <dt><span class="paramLabel">Parameters:</span></dt>
  374. <dd><code>chr</code> - the buffer to read the characters into</dd>
  375. <dd><code>st</code> - The start offset</dd>
  376. <dd><code>len</code> - The number of bytes to read</dd>
  377. <dt><span class="returnLabel">Returns:</span></dt>
  378. <dd>the number of characters read or -1 if the end of stream</dd>
  379. <dt><span class="throwsLabel">Throws:</span></dt>
  380. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  381. </dl>
  382. </li>
  383. </ul>
  384. <a name="read-java.nio.CharBuffer-">
  385. <!-- -->
  386. </a>
  387. <ul class="blockList">
  388. <li class="blockList">
  389. <h4>read</h4>
  390. <pre>public&nbsp;int&nbsp;read(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/CharBuffer.html?is-external=true" title="class or interface in java.nio">CharBuffer</a>&nbsp;target)
  391. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  392. <div class="block">Invokes the delegate's <code>read(CharBuffer)</code> method.</div>
  393. <dl>
  394. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  395. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Readable.html?is-external=true#read-java.nio.CharBuffer-" title="class or interface in java.lang">read</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Readable.html?is-external=true" title="class or interface in java.lang">Readable</a></code></dd>
  396. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  397. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true#read-java.nio.CharBuffer-" title="class or interface in java.io">read</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a></code></dd>
  398. <dt><span class="paramLabel">Parameters:</span></dt>
  399. <dd><code>target</code> - the char buffer to read the characters into</dd>
  400. <dt><span class="returnLabel">Returns:</span></dt>
  401. <dd>the number of characters read or -1 if the end of stream</dd>
  402. <dt><span class="throwsLabel">Throws:</span></dt>
  403. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  404. <dt><span class="simpleTagLabel">Since:</span></dt>
  405. <dd>2.0</dd>
  406. </dl>
  407. </li>
  408. </ul>
  409. <a name="skip-long-">
  410. <!-- -->
  411. </a>
  412. <ul class="blockList">
  413. <li class="blockList">
  414. <h4>skip</h4>
  415. <pre>public&nbsp;long&nbsp;skip(long&nbsp;ln)
  416. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  417. <div class="block">Invokes the delegate's <code>skip(long)</code> method.</div>
  418. <dl>
  419. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  420. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#skip-long-" title="class or interface in java.io">skip</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  421. <dt><span class="paramLabel">Parameters:</span></dt>
  422. <dd><code>ln</code> - the number of bytes to skip</dd>
  423. <dt><span class="returnLabel">Returns:</span></dt>
  424. <dd>the number of bytes to skipped or EOF if the end of stream</dd>
  425. <dt><span class="throwsLabel">Throws:</span></dt>
  426. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  427. </dl>
  428. </li>
  429. </ul>
  430. <a name="ready--">
  431. <!-- -->
  432. </a>
  433. <ul class="blockList">
  434. <li class="blockList">
  435. <h4>ready</h4>
  436. <pre>public&nbsp;boolean&nbsp;ready()
  437. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  438. <div class="block">Invokes the delegate's <code>ready()</code> method.</div>
  439. <dl>
  440. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  441. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#ready--" title="class or interface in java.io">ready</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  442. <dt><span class="returnLabel">Returns:</span></dt>
  443. <dd>true if the stream is ready to be read</dd>
  444. <dt><span class="throwsLabel">Throws:</span></dt>
  445. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  446. </dl>
  447. </li>
  448. </ul>
  449. <a name="close--">
  450. <!-- -->
  451. </a>
  452. <ul class="blockList">
  453. <li class="blockList">
  454. <h4>close</h4>
  455. <pre>public&nbsp;void&nbsp;close()
  456. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  457. <div class="block">Invokes the delegate's <code>close()</code> method.</div>
  458. <dl>
  459. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  460. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
  461. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  462. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
  463. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  464. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  465. <dt><span class="throwsLabel">Throws:</span></dt>
  466. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  467. </dl>
  468. </li>
  469. </ul>
  470. <a name="mark-int-">
  471. <!-- -->
  472. </a>
  473. <ul class="blockList">
  474. <li class="blockList">
  475. <h4>mark</h4>
  476. <pre>public&nbsp;void&nbsp;mark(int&nbsp;idx)
  477. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  478. <div class="block">Invokes the delegate's <code>mark(int)</code> method.</div>
  479. <dl>
  480. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  481. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#mark-int-" title="class or interface in java.io">mark</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  482. <dt><span class="paramLabel">Parameters:</span></dt>
  483. <dd><code>idx</code> - read ahead limit</dd>
  484. <dt><span class="throwsLabel">Throws:</span></dt>
  485. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  486. </dl>
  487. </li>
  488. </ul>
  489. <a name="reset--">
  490. <!-- -->
  491. </a>
  492. <ul class="blockList">
  493. <li class="blockList">
  494. <h4>reset</h4>
  495. <pre>public&nbsp;void&nbsp;reset()
  496. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  497. <div class="block">Invokes the delegate's <code>reset()</code> method.</div>
  498. <dl>
  499. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  500. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#reset--" title="class or interface in java.io">reset</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  501. <dt><span class="throwsLabel">Throws:</span></dt>
  502. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  503. </dl>
  504. </li>
  505. </ul>
  506. <a name="markSupported--">
  507. <!-- -->
  508. </a>
  509. <ul class="blockList">
  510. <li class="blockList">
  511. <h4>markSupported</h4>
  512. <pre>public&nbsp;boolean&nbsp;markSupported()</pre>
  513. <div class="block">Invokes the delegate's <code>markSupported()</code> method.</div>
  514. <dl>
  515. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  516. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true#markSupported--" title="class or interface in java.io">markSupported</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterReader.html?is-external=true" title="class or interface in java.io">FilterReader</a></code></dd>
  517. <dt><span class="returnLabel">Returns:</span></dt>
  518. <dd>true if mark is supported, otherwise false</dd>
  519. </dl>
  520. </li>
  521. </ul>
  522. <a name="beforeRead-int-">
  523. <!-- -->
  524. </a>
  525. <ul class="blockList">
  526. <li class="blockList">
  527. <h4>beforeRead</h4>
  528. <pre>protected&nbsp;void&nbsp;beforeRead(int&nbsp;n)
  529. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  530. <div class="block">Invoked by the read methods before the call is proxied. The number
  531. of chars that the caller wanted to read (1 for the <a href="../../../../../org/apache/commons/io/input/ProxyReader.html#read--"><code>read()</code></a>
  532. method, buffer length for <a href="../../../../../org/apache/commons/io/input/ProxyReader.html#read-char:A-"><code>read(char[])</code></a>, etc.) is given as
  533. an argument.
  534. <p>
  535. Subclasses can override this method to add common pre-processing
  536. functionality without having to override all the read methods.
  537. The default implementation does nothing.
  538. <p>
  539. Note this method is <em>not</em> called from <a href="../../../../../org/apache/commons/io/input/ProxyReader.html#skip-long-"><code>skip(long)</code></a> or
  540. <a href="../../../../../org/apache/commons/io/input/ProxyReader.html#reset--"><code>reset()</code></a>. You need to explicitly override those methods if
  541. you want to add pre-processing steps also to them.</div>
  542. <dl>
  543. <dt><span class="paramLabel">Parameters:</span></dt>
  544. <dd><code>n</code> - number of chars that the caller asked to be read</dd>
  545. <dt><span class="throwsLabel">Throws:</span></dt>
  546. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the pre-processing fails</dd>
  547. <dt><span class="simpleTagLabel">Since:</span></dt>
  548. <dd>2.0</dd>
  549. </dl>
  550. </li>
  551. </ul>
  552. <a name="afterRead-int-">
  553. <!-- -->
  554. </a>
  555. <ul class="blockList">
  556. <li class="blockList">
  557. <h4>afterRead</h4>
  558. <pre>protected&nbsp;void&nbsp;afterRead(int&nbsp;n)
  559. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  560. <div class="block">Invoked by the read methods after the proxied call has returned
  561. successfully. The number of chars returned to the caller (or -1 if
  562. the end of stream was reached) is given as an argument.
  563. <p>
  564. Subclasses can override this method to add common post-processing
  565. functionality without having to override all the read methods.
  566. The default implementation does nothing.
  567. <p>
  568. Note this method is <em>not</em> called from <a href="../../../../../org/apache/commons/io/input/ProxyReader.html#skip-long-"><code>skip(long)</code></a> or
  569. <a href="../../../../../org/apache/commons/io/input/ProxyReader.html#reset--"><code>reset()</code></a>. You need to explicitly override those methods if
  570. you want to add post-processing steps also to them.</div>
  571. <dl>
  572. <dt><span class="paramLabel">Parameters:</span></dt>
  573. <dd><code>n</code> - number of chars read, or -1 if the end of stream was reached</dd>
  574. <dt><span class="throwsLabel">Throws:</span></dt>
  575. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the post-processing fails</dd>
  576. <dt><span class="simpleTagLabel">Since:</span></dt>
  577. <dd>2.0</dd>
  578. </dl>
  579. </li>
  580. </ul>
  581. <a name="handleIOException-java.io.IOException-">
  582. <!-- -->
  583. </a>
  584. <ul class="blockListLast">
  585. <li class="blockList">
  586. <h4>handleIOException</h4>
  587. <pre>protected&nbsp;void&nbsp;handleIOException(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;e)
  588. throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
  589. <div class="block">Handle any IOExceptions thrown.
  590. <p>
  591. This method provides a point to implement custom exception
  592. handling. The default behaviour is to re-throw the exception.</div>
  593. <dl>
  594. <dt><span class="paramLabel">Parameters:</span></dt>
  595. <dd><code>e</code> - The IOException thrown</dd>
  596. <dt><span class="throwsLabel">Throws:</span></dt>
  597. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an I/O error occurs</dd>
  598. <dt><span class="simpleTagLabel">Since:</span></dt>
  599. <dd>2.0</dd>
  600. </dl>
  601. </li>
  602. </ul>
  603. </li>
  604. </ul>
  605. </li>
  606. </ul>
  607. </div>
  608. </div>
  609. <!-- ========= END OF CLASS DATA ========= -->
  610. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  611. <div class="bottomNav"><a name="navbar.bottom">
  612. <!-- -->
  613. </a>
  614. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  615. <a name="navbar.bottom.firstrow">
  616. <!-- -->
  617. </a>
  618. <ul class="navList" title="Navigation">
  619. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  620. <li><a href="package-summary.html">Package</a></li>
  621. <li class="navBarCell1Rev">Class</li>
  622. <li><a href="class-use/ProxyReader.html">Use</a></li>
  623. <li><a href="package-tree.html">Tree</a></li>
  624. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  625. <li><a href="../../../../../index-all.html">Index</a></li>
  626. <li><a href="../../../../../help-doc.html">Help</a></li>
  627. </ul>
  628. </div>
  629. <div class="subNav">
  630. <ul class="navList">
  631. <li><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  632. <li><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  633. </ul>
  634. <ul class="navList">
  635. <li><a href="../../../../../index.html?org/apache/commons/io/input/ProxyReader.html" target="_top">Frames</a></li>
  636. <li><a href="ProxyReader.html" target="_top">No&nbsp;Frames</a></li>
  637. </ul>
  638. <ul class="navList" id="allclasses_navbar_bottom">
  639. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  640. </ul>
  641. <div>
  642. <script type="text/javascript"><!--
  643. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  644. if(window==top) {
  645. allClassesLink.style.display = "block";
  646. }
  647. else {
  648. allClassesLink.style.display = "none";
  649. }
  650. //-->
  651. </script>
  652. </div>
  653. <div>
  654. <ul class="subNavList">
  655. <li>Summary:&nbsp;</li>
  656. <li>Nested&nbsp;|&nbsp;</li>
  657. <li><a href="#fields.inherited.from.class.java.io.FilterReader">Field</a>&nbsp;|&nbsp;</li>
  658. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  659. <li><a href="#method.summary">Method</a></li>
  660. </ul>
  661. <ul class="subNavList">
  662. <li>Detail:&nbsp;</li>
  663. <li>Field&nbsp;|&nbsp;</li>
  664. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  665. <li><a href="#method.detail">Method</a></li>
  666. </ul>
  667. </div>
  668. <a name="skip.navbar.bottom">
  669. <!-- -->
  670. </a></div>
  671. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  672. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  673. </body>
  674. </html>