ObservableInputStream.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688
  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>ObservableInputStream (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="ObservableInputStream (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,"i13":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/ObservableInputStream.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/NullReader.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/ObservableInputStream.Observer.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/ObservableInputStream.html" target="_top">Frames</a></li>
  57. <li><a href="ObservableInputStream.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  78. <li><a href="#fields.inherited.from.class.java.io.FilterInputStream">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 ObservableInputStream" class="title">Class ObservableInputStream</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/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">java.io.FilterInputStream</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">org.apache.commons.io.input.ProxyInputStream</a></li>
  110. <li>
  111. <ul class="inheritance">
  112. <li>org.apache.commons.io.input.ObservableInputStream</li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </li>
  119. </ul>
  120. </li>
  121. </ul>
  122. <div class="description">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <dl>
  126. <dt>All Implemented Interfaces:</dt>
  127. <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></dd>
  128. </dl>
  129. <dl>
  130. <dt>Direct Known Subclasses:</dt>
  131. <dd><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" title="class in org.apache.commons.io.input">MessageDigestCalculatingInputStream</a></dd>
  132. </dl>
  133. <hr>
  134. <br>
  135. <pre>public class <span class="typeNameLabel">ObservableInputStream</span>
  136. extends <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></pre>
  137. <div class="block">The <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a> allows, that an InputStream may be consumed
  138. by other receivers, apart from the thread, which is reading it.
  139. The other consumers are implemented as instances of <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream.Observer</code></a>. A
  140. typical application may be the generation of a <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a> on the
  141. fly.
  142. <code>Note</code>: The <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a> is <em>not</em> thread safe,
  143. as instances of InputStream usually aren't.
  144. If you must access the stream from multiple threads, then synchronization, locking,
  145. or a similar means must be used.</div>
  146. <dl>
  147. <dt><span class="seeLabel">See Also:</span></dt>
  148. <dd><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" title="class in org.apache.commons.io.input"><code>MessageDigestCalculatingInputStream</code></a></dd>
  149. </dl>
  150. </li>
  151. </ul>
  152. </div>
  153. <div class="summary">
  154. <ul class="blockList">
  155. <li class="blockList">
  156. <!-- ======== NESTED CLASS SUMMARY ======== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="nested.class.summary">
  159. <!-- -->
  160. </a>
  161. <h3>Nested Class Summary</h3>
  162. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
  163. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  164. <tr>
  165. <th class="colFirst" scope="col">Modifier and Type</th>
  166. <th class="colLast" scope="col">Class and Description</th>
  167. </tr>
  168. <tr class="altColor">
  169. <td class="colFirst"><code>static class&nbsp;</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a></span></code>&nbsp;</td>
  171. </tr>
  172. </table>
  173. </li>
  174. </ul>
  175. <!-- =========== FIELD SUMMARY =========== -->
  176. <ul class="blockList">
  177. <li class="blockList"><a name="field.summary">
  178. <!-- -->
  179. </a>
  180. <h3>Field Summary</h3>
  181. <ul class="blockList">
  182. <li class="blockList"><a name="fields.inherited.from.class.java.io.FilterInputStream">
  183. <!-- -->
  184. </a>
  185. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">FilterInputStream</a></h3>
  186. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true#in" title="class or interface in java.io">in</a></code></li>
  187. </ul>
  188. </li>
  189. </ul>
  190. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  191. <ul class="blockList">
  192. <li class="blockList"><a name="constructor.summary">
  193. <!-- -->
  194. </a>
  195. <h3>Constructor Summary</h3>
  196. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  197. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  198. <tr>
  199. <th class="colOne" scope="col">Constructor and Description</th>
  200. </tr>
  201. <tr class="altColor">
  202. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#ObservableInputStream-java.io.InputStream-">ObservableInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pProxy)</code>
  203. <div class="block">Creates a new ObservableInputStream for the given InputStream.</div>
  204. </td>
  205. </tr>
  206. </table>
  207. </li>
  208. </ul>
  209. <!-- ========== METHOD SUMMARY =========== -->
  210. <ul class="blockList">
  211. <li class="blockList"><a name="method.summary">
  212. <!-- -->
  213. </a>
  214. <h3>Method Summary</h3>
  215. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  216. <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>
  217. <tr>
  218. <th class="colFirst" scope="col">Modifier and Type</th>
  219. <th class="colLast" scope="col">Method and Description</th>
  220. </tr>
  221. <tr id="i0" class="altColor">
  222. <td class="colFirst"><code>void</code></td>
  223. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#add-org.apache.commons.io.input.ObservableInputStream.Observer-">add</a></span>(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>&nbsp;pObserver)</code>
  224. <div class="block">Adds an Observer.</div>
  225. </td>
  226. </tr>
  227. <tr id="i1" class="rowColor">
  228. <td class="colFirst"><code>void</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#close--">close</a></span>()</code>
  230. <div class="block">Invokes the delegate's <code>close()</code> method.</div>
  231. </td>
  232. </tr>
  233. <tr id="i2" class="altColor">
  234. <td class="colFirst"><code>void</code></td>
  235. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#consume--">consume</a></span>()</code>
  236. <div class="block">Reads all data from the underlying <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, while notifying the
  237. observers.</div>
  238. </td>
  239. </tr>
  240. <tr id="i3" class="rowColor">
  241. <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>&gt;</code></td>
  242. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#getObservers--">getObservers</a></span>()</code>
  243. <div class="block">Gets all currently registered observers.</div>
  244. </td>
  245. </tr>
  246. <tr id="i4" class="altColor">
  247. <td class="colFirst"><code>protected void</code></td>
  248. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteClosed--">noteClosed</a></span>()</code>
  249. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
  250. </td>
  251. </tr>
  252. <tr id="i5" class="rowColor">
  253. <td class="colFirst"><code>protected void</code></td>
  254. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteDataByte-int-">noteDataByte</a></span>(int&nbsp;pDataByte)</code>
  255. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-int-"><code>ObservableInputStream.Observer.data(int)</code></a>
  256. with the given arguments.</div>
  257. </td>
  258. </tr>
  259. <tr id="i6" class="altColor">
  260. <td class="colFirst"><code>protected void</code></td>
  261. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteDataBytes-byte:A-int-int-">noteDataBytes</a></span>(byte[]&nbsp;pBuffer,
  262. int&nbsp;pOffset,
  263. int&nbsp;pLength)</code>
  264. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-byte:A-int-int-"><code>ObservableInputStream.Observer.data(byte[],int,int)</code></a>
  265. with the given arguments.</div>
  266. </td>
  267. </tr>
  268. <tr id="i7" class="rowColor">
  269. <td class="colFirst"><code>protected void</code></td>
  270. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteError-java.io.IOException-">noteError</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;pException)</code>
  271. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#error-java.io.IOException-"><code>ObservableInputStream.Observer.error(IOException)</code></a>
  272. with the given argument.</div>
  273. </td>
  274. </tr>
  275. <tr id="i8" class="altColor">
  276. <td class="colFirst"><code>protected void</code></td>
  277. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteFinished--">noteFinished</a></span>()</code>
  278. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
  279. </td>
  280. </tr>
  281. <tr id="i9" class="rowColor">
  282. <td class="colFirst"><code>int</code></td>
  283. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read--">read</a></span>()</code>
  284. <div class="block">Invokes the delegate's <code>read()</code> method.</div>
  285. </td>
  286. </tr>
  287. <tr id="i10" class="altColor">
  288. <td class="colFirst"><code>int</code></td>
  289. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read-byte:A-">read</a></span>(byte[]&nbsp;pBuffer)</code>
  290. <div class="block">Invokes the delegate's <code>read(byte[])</code> method.</div>
  291. </td>
  292. </tr>
  293. <tr id="i11" class="rowColor">
  294. <td class="colFirst"><code>int</code></td>
  295. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read-byte:A-int-int-">read</a></span>(byte[]&nbsp;pBuffer,
  296. int&nbsp;pOffset,
  297. int&nbsp;pLength)</code>
  298. <div class="block">Invokes the delegate's <code>read(byte[], int, int)</code> method.</div>
  299. </td>
  300. </tr>
  301. <tr id="i12" class="altColor">
  302. <td class="colFirst"><code>void</code></td>
  303. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#remove-org.apache.commons.io.input.ObservableInputStream.Observer-">remove</a></span>(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>&nbsp;pObserver)</code>
  304. <div class="block">Removes an Observer.</div>
  305. </td>
  306. </tr>
  307. <tr id="i13" class="rowColor">
  308. <td class="colFirst"><code>void</code></td>
  309. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#removeAllObservers--">removeAllObservers</a></span>()</code>
  310. <div class="block">Removes all Observers.</div>
  311. </td>
  312. </tr>
  313. </table>
  314. <ul class="blockList">
  315. <li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.io.input.ProxyInputStream">
  316. <!-- -->
  317. </a>
  318. <h3>Methods inherited from class&nbsp;org.apache.commons.io.input.<a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></h3>
  319. <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#afterRead-int-">afterRead</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#available--">available</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#beforeRead-int-">beforeRead</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#handleIOException-java.io.IOException-">handleIOException</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#mark-int-">mark</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#markSupported--">markSupported</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#reset--">reset</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#skip-long-">skip</a></code></li>
  320. </ul>
  321. <ul class="blockList">
  322. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  323. <!-- -->
  324. </a>
  325. <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>
  326. <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>
  327. </ul>
  328. </li>
  329. </ul>
  330. </li>
  331. </ul>
  332. </div>
  333. <div class="details">
  334. <ul class="blockList">
  335. <li class="blockList">
  336. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  337. <ul class="blockList">
  338. <li class="blockList"><a name="constructor.detail">
  339. <!-- -->
  340. </a>
  341. <h3>Constructor Detail</h3>
  342. <a name="ObservableInputStream-java.io.InputStream-">
  343. <!-- -->
  344. </a>
  345. <ul class="blockListLast">
  346. <li class="blockList">
  347. <h4>ObservableInputStream</h4>
  348. <pre>public&nbsp;ObservableInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;pProxy)</pre>
  349. <div class="block">Creates a new ObservableInputStream for the given InputStream.</div>
  350. <dl>
  351. <dt><span class="paramLabel">Parameters:</span></dt>
  352. <dd><code>pProxy</code> - the input stream to proxy</dd>
  353. </dl>
  354. </li>
  355. </ul>
  356. </li>
  357. </ul>
  358. <!-- ============ METHOD DETAIL ========== -->
  359. <ul class="blockList">
  360. <li class="blockList"><a name="method.detail">
  361. <!-- -->
  362. </a>
  363. <h3>Method Detail</h3>
  364. <a name="add-org.apache.commons.io.input.ObservableInputStream.Observer-">
  365. <!-- -->
  366. </a>
  367. <ul class="blockList">
  368. <li class="blockList">
  369. <h4>add</h4>
  370. <pre>public&nbsp;void&nbsp;add(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>&nbsp;pObserver)</pre>
  371. <div class="block">Adds an Observer.</div>
  372. <dl>
  373. <dt><span class="paramLabel">Parameters:</span></dt>
  374. <dd><code>pObserver</code> - the observer to add</dd>
  375. </dl>
  376. </li>
  377. </ul>
  378. <a name="remove-org.apache.commons.io.input.ObservableInputStream.Observer-">
  379. <!-- -->
  380. </a>
  381. <ul class="blockList">
  382. <li class="blockList">
  383. <h4>remove</h4>
  384. <pre>public&nbsp;void&nbsp;remove(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>&nbsp;pObserver)</pre>
  385. <div class="block">Removes an Observer.</div>
  386. <dl>
  387. <dt><span class="paramLabel">Parameters:</span></dt>
  388. <dd><code>pObserver</code> - the observer to remove</dd>
  389. </dl>
  390. </li>
  391. </ul>
  392. <a name="removeAllObservers--">
  393. <!-- -->
  394. </a>
  395. <ul class="blockList">
  396. <li class="blockList">
  397. <h4>removeAllObservers</h4>
  398. <pre>public&nbsp;void&nbsp;removeAllObservers()</pre>
  399. <div class="block">Removes all Observers.</div>
  400. </li>
  401. </ul>
  402. <a name="read--">
  403. <!-- -->
  404. </a>
  405. <ul class="blockList">
  406. <li class="blockList">
  407. <h4>read</h4>
  408. <pre>public&nbsp;int&nbsp;read()
  409. 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>
  410. <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read--">ProxyInputStream</a></code></span></div>
  411. <div class="block">Invokes the delegate's <code>read()</code> method.</div>
  412. <dl>
  413. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  414. <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read--">read</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
  415. <dt><span class="returnLabel">Returns:</span></dt>
  416. <dd>the byte read or -1 if the end of stream</dd>
  417. <dt><span class="throwsLabel">Throws:</span></dt>
  418. <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>
  419. </dl>
  420. </li>
  421. </ul>
  422. <a name="read-byte:A-">
  423. <!-- -->
  424. </a>
  425. <ul class="blockList">
  426. <li class="blockList">
  427. <h4>read</h4>
  428. <pre>public&nbsp;int&nbsp;read(byte[]&nbsp;pBuffer)
  429. 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>
  430. <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-">ProxyInputStream</a></code></span></div>
  431. <div class="block">Invokes the delegate's <code>read(byte[])</code> method.</div>
  432. <dl>
  433. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  434. <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-">read</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
  435. <dt><span class="paramLabel">Parameters:</span></dt>
  436. <dd><code>pBuffer</code> - the buffer to read the bytes into</dd>
  437. <dt><span class="returnLabel">Returns:</span></dt>
  438. <dd>the number of bytes read or EOF if the end of stream</dd>
  439. <dt><span class="throwsLabel">Throws:</span></dt>
  440. <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>
  441. </dl>
  442. </li>
  443. </ul>
  444. <a name="read-byte:A-int-int-">
  445. <!-- -->
  446. </a>
  447. <ul class="blockList">
  448. <li class="blockList">
  449. <h4>read</h4>
  450. <pre>public&nbsp;int&nbsp;read(byte[]&nbsp;pBuffer,
  451. int&nbsp;pOffset,
  452. int&nbsp;pLength)
  453. 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>
  454. <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-int-int-">ProxyInputStream</a></code></span></div>
  455. <div class="block">Invokes the delegate's <code>read(byte[], int, int)</code> method.</div>
  456. <dl>
  457. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  458. <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-int-int-">read</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
  459. <dt><span class="paramLabel">Parameters:</span></dt>
  460. <dd><code>pBuffer</code> - the buffer to read the bytes into</dd>
  461. <dd><code>pOffset</code> - The start offset</dd>
  462. <dd><code>pLength</code> - The number of bytes to read</dd>
  463. <dt><span class="returnLabel">Returns:</span></dt>
  464. <dd>the number of bytes read or -1 if the end of stream</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="noteDataBytes-byte:A-int-int-">
  471. <!-- -->
  472. </a>
  473. <ul class="blockList">
  474. <li class="blockList">
  475. <h4>noteDataBytes</h4>
  476. <pre>protected&nbsp;void&nbsp;noteDataBytes(byte[]&nbsp;pBuffer,
  477. int&nbsp;pOffset,
  478. int&nbsp;pLength)
  479. 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>
  480. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-byte:A-int-int-"><code>ObservableInputStream.Observer.data(byte[],int,int)</code></a>
  481. with the given arguments.</div>
  482. <dl>
  483. <dt><span class="paramLabel">Parameters:</span></dt>
  484. <dd><code>pBuffer</code> - Passed to the observers.</dd>
  485. <dd><code>pOffset</code> - Passed to the observers.</dd>
  486. <dd><code>pLength</code> - Passed to the observers.</dd>
  487. <dt><span class="throwsLabel">Throws:</span></dt>
  488. <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> - Some observer has thrown an exception, which is being
  489. passed down.</dd>
  490. </dl>
  491. </li>
  492. </ul>
  493. <a name="noteFinished--">
  494. <!-- -->
  495. </a>
  496. <ul class="blockList">
  497. <li class="blockList">
  498. <h4>noteFinished</h4>
  499. <pre>protected&nbsp;void&nbsp;noteFinished()
  500. 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>
  501. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
  502. <dl>
  503. <dt><span class="throwsLabel">Throws:</span></dt>
  504. <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> - Some observer has thrown an exception, which is being
  505. passed down.</dd>
  506. </dl>
  507. </li>
  508. </ul>
  509. <a name="noteDataByte-int-">
  510. <!-- -->
  511. </a>
  512. <ul class="blockList">
  513. <li class="blockList">
  514. <h4>noteDataByte</h4>
  515. <pre>protected&nbsp;void&nbsp;noteDataByte(int&nbsp;pDataByte)
  516. 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>
  517. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-int-"><code>ObservableInputStream.Observer.data(int)</code></a>
  518. with the given arguments.</div>
  519. <dl>
  520. <dt><span class="paramLabel">Parameters:</span></dt>
  521. <dd><code>pDataByte</code> - Passed to the observers.</dd>
  522. <dt><span class="throwsLabel">Throws:</span></dt>
  523. <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> - Some observer has thrown an exception, which is being
  524. passed down.</dd>
  525. </dl>
  526. </li>
  527. </ul>
  528. <a name="noteError-java.io.IOException-">
  529. <!-- -->
  530. </a>
  531. <ul class="blockList">
  532. <li class="blockList">
  533. <h4>noteError</h4>
  534. <pre>protected&nbsp;void&nbsp;noteError(<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;pException)
  535. 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>
  536. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#error-java.io.IOException-"><code>ObservableInputStream.Observer.error(IOException)</code></a>
  537. with the given argument.</div>
  538. <dl>
  539. <dt><span class="paramLabel">Parameters:</span></dt>
  540. <dd><code>pException</code> - Passed to the observers.</dd>
  541. <dt><span class="throwsLabel">Throws:</span></dt>
  542. <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> - Some observer has thrown an exception, which is being
  543. passed down. This may be the same exception, which has been passed as an
  544. argument.</dd>
  545. </dl>
  546. </li>
  547. </ul>
  548. <a name="noteClosed--">
  549. <!-- -->
  550. </a>
  551. <ul class="blockList">
  552. <li class="blockList">
  553. <h4>noteClosed</h4>
  554. <pre>protected&nbsp;void&nbsp;noteClosed()
  555. 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>
  556. <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
  557. <dl>
  558. <dt><span class="throwsLabel">Throws:</span></dt>
  559. <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> - Some observer has thrown an exception, which is being
  560. passed down.</dd>
  561. </dl>
  562. </li>
  563. </ul>
  564. <a name="getObservers--">
  565. <!-- -->
  566. </a>
  567. <ul class="blockList">
  568. <li class="blockList">
  569. <h4>getObservers</h4>
  570. <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>&gt;&nbsp;getObservers()</pre>
  571. <div class="block">Gets all currently registered observers.</div>
  572. <dl>
  573. <dt><span class="returnLabel">Returns:</span></dt>
  574. <dd>a list of the currently registered observers</dd>
  575. </dl>
  576. </li>
  577. </ul>
  578. <a name="close--">
  579. <!-- -->
  580. </a>
  581. <ul class="blockList">
  582. <li class="blockList">
  583. <h4>close</h4>
  584. <pre>public&nbsp;void&nbsp;close()
  585. 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>
  586. <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#close--">ProxyInputStream</a></code></span></div>
  587. <div class="block">Invokes the delegate's <code>close()</code> method.</div>
  588. <dl>
  589. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  590. <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>
  591. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  592. <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>
  593. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  594. <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#close--">close</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
  595. <dt><span class="throwsLabel">Throws:</span></dt>
  596. <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>
  597. </dl>
  598. </li>
  599. </ul>
  600. <a name="consume--">
  601. <!-- -->
  602. </a>
  603. <ul class="blockListLast">
  604. <li class="blockList">
  605. <h4>consume</h4>
  606. <pre>public&nbsp;void&nbsp;consume()
  607. 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>
  608. <div class="block">Reads all data from the underlying <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, while notifying the
  609. observers.</div>
  610. <dl>
  611. <dt><span class="throwsLabel">Throws:</span></dt>
  612. <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> - The underlying <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, or either of the
  613. observers has thrown an exception.</dd>
  614. </dl>
  615. </li>
  616. </ul>
  617. </li>
  618. </ul>
  619. </li>
  620. </ul>
  621. </div>
  622. </div>
  623. <!-- ========= END OF CLASS DATA ========= -->
  624. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  625. <div class="bottomNav"><a name="navbar.bottom">
  626. <!-- -->
  627. </a>
  628. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  629. <a name="navbar.bottom.firstrow">
  630. <!-- -->
  631. </a>
  632. <ul class="navList" title="Navigation">
  633. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  634. <li><a href="package-summary.html">Package</a></li>
  635. <li class="navBarCell1Rev">Class</li>
  636. <li><a href="class-use/ObservableInputStream.html">Use</a></li>
  637. <li><a href="package-tree.html">Tree</a></li>
  638. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  639. <li><a href="../../../../../index-all.html">Index</a></li>
  640. <li><a href="../../../../../help-doc.html">Help</a></li>
  641. </ul>
  642. </div>
  643. <div class="subNav">
  644. <ul class="navList">
  645. <li><a href="../../../../../org/apache/commons/io/input/NullReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  646. <li><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  647. </ul>
  648. <ul class="navList">
  649. <li><a href="../../../../../index.html?org/apache/commons/io/input/ObservableInputStream.html" target="_top">Frames</a></li>
  650. <li><a href="ObservableInputStream.html" target="_top">No&nbsp;Frames</a></li>
  651. </ul>
  652. <ul class="navList" id="allclasses_navbar_bottom">
  653. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  654. </ul>
  655. <div>
  656. <script type="text/javascript"><!--
  657. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  658. if(window==top) {
  659. allClassesLink.style.display = "block";
  660. }
  661. else {
  662. allClassesLink.style.display = "none";
  663. }
  664. //-->
  665. </script>
  666. </div>
  667. <div>
  668. <ul class="subNavList">
  669. <li>Summary:&nbsp;</li>
  670. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  671. <li><a href="#fields.inherited.from.class.java.io.FilterInputStream">Field</a>&nbsp;|&nbsp;</li>
  672. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  673. <li><a href="#method.summary">Method</a></li>
  674. </ul>
  675. <ul class="subNavList">
  676. <li>Detail:&nbsp;</li>
  677. <li>Field&nbsp;|&nbsp;</li>
  678. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  679. <li><a href="#method.detail">Method</a></li>
  680. </ul>
  681. </div>
  682. <a name="skip.navbar.bottom">
  683. <!-- -->
  684. </a></div>
  685. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  686. <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>
  687. </body>
  688. </html>