package-summary.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  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>org.apache.commons.io.input (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="org.apache.commons.io.input (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. </script>
  22. <noscript>
  23. <div>JavaScript is disabled on your browser.</div>
  24. </noscript>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <div class="topNav"><a name="navbar.top">
  27. <!-- -->
  28. </a>
  29. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  30. <a name="navbar.top.firstrow">
  31. <!-- -->
  32. </a>
  33. <ul class="navList" title="Navigation">
  34. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  35. <li class="navBarCell1Rev">Package</li>
  36. <li>Class</li>
  37. <li><a href="package-use.html">Use</a></li>
  38. <li><a href="package-tree.html">Tree</a></li>
  39. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  40. <li><a href="../../../../../index-all.html">Index</a></li>
  41. <li><a href="../../../../../help-doc.html">Help</a></li>
  42. </ul>
  43. </div>
  44. <div class="subNav">
  45. <ul class="navList">
  46. <li><a href="../../../../../org/apache/commons/io/filefilter/package-summary.html">Prev&nbsp;Package</a></li>
  47. <li><a href="../../../../../org/apache/commons/io/monitor/package-summary.html">Next&nbsp;Package</a></li>
  48. </ul>
  49. <ul class="navList">
  50. <li><a href="../../../../../index.html?org/apache/commons/io/input/package-summary.html" target="_top">Frames</a></li>
  51. <li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
  52. </ul>
  53. <ul class="navList" id="allclasses_navbar_top">
  54. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  55. </ul>
  56. <div>
  57. <script type="text/javascript"><!--
  58. allClassesLink = document.getElementById("allclasses_navbar_top");
  59. if(window==top) {
  60. allClassesLink.style.display = "block";
  61. }
  62. else {
  63. allClassesLink.style.display = "none";
  64. }
  65. //-->
  66. </script>
  67. </div>
  68. <a name="skip.navbar.top">
  69. <!-- -->
  70. </a></div>
  71. <!-- ========= END OF TOP NAVBAR ========= -->
  72. <div class="header">
  73. <h1 title="Package" class="title">Package&nbsp;org.apache.commons.io.input</h1>
  74. <div class="docSummary">
  75. <div class="block">
  76. This package provides implementations of input classes, such as
  77. <code>InputStream</code> and <code>Reader</code>.</div>
  78. </div>
  79. <p>See:&nbsp;<a href="#package.description">Description</a></p>
  80. </div>
  81. <div class="contentContainer">
  82. <ul class="blockList">
  83. <li class="blockList">
  84. <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
  85. <caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
  86. <tr>
  87. <th class="colFirst" scope="col">Interface</th>
  88. <th class="colLast" scope="col">Description</th>
  89. </tr>
  90. <tbody>
  91. <tr class="altColor">
  92. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/TailerListener.html" title="interface in org.apache.commons.io.input">TailerListener</a></td>
  93. <td class="colLast">
  94. <div class="block">Listener for events from a <a href="../../../../../org/apache/commons/io/input/Tailer.html" title="class in org.apache.commons.io.input"><code>Tailer</code></a>.</div>
  95. </td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. </li>
  100. <li class="blockList">
  101. <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
  102. <caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
  103. <tr>
  104. <th class="colFirst" scope="col">Class</th>
  105. <th class="colLast" scope="col">Description</th>
  106. </tr>
  107. <tbody>
  108. <tr class="altColor">
  109. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/AutoCloseInputStream.html" title="class in org.apache.commons.io.input">AutoCloseInputStream</a></td>
  110. <td class="colLast">
  111. <div class="block">Proxy stream that closes and discards the underlying stream as soon as the
  112. end of input has been reached or when the stream is explicitly closed.</div>
  113. </td>
  114. </tr>
  115. <tr class="rowColor">
  116. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/BOMInputStream.html" title="class in org.apache.commons.io.input">BOMInputStream</a></td>
  117. <td class="colLast">
  118. <div class="block">This class is used to wrap a stream that includes an encoded <a href="../../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io"><code>ByteOrderMark</code></a> as its first bytes.</div>
  119. </td>
  120. </tr>
  121. <tr class="altColor">
  122. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/BoundedInputStream.html" title="class in org.apache.commons.io.input">BoundedInputStream</a></td>
  123. <td class="colLast">
  124. <div class="block">This is a stream that will only supply bytes up to a certain length - if its
  125. position goes above that, it will stop.</div>
  126. </td>
  127. </tr>
  128. <tr class="rowColor">
  129. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/BoundedReader.html" title="class in org.apache.commons.io.input">BoundedReader</a></td>
  130. <td class="colLast">
  131. <div class="block">A reader that imposes a limit to the number of characters that can be read from
  132. an underlying reader, returning eof when this limit is reached -regardless of state of
  133. underlying reader.</div>
  134. </td>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/BrokenInputStream.html" title="class in org.apache.commons.io.input">BrokenInputStream</a></td>
  138. <td class="colLast">
  139. <div class="block">Broken input stream.</div>
  140. </td>
  141. </tr>
  142. <tr class="rowColor">
  143. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/CharSequenceInputStream.html" title="class in org.apache.commons.io.input">CharSequenceInputStream</a></td>
  144. <td class="colLast">
  145. <div class="block"><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> implementation that can read from String, StringBuffer,
  146. StringBuilder or CharBuffer.</div>
  147. </td>
  148. </tr>
  149. <tr class="altColor">
  150. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/CharSequenceReader.html" title="class in org.apache.commons.io.input">CharSequenceReader</a></td>
  151. <td class="colLast">
  152. <div class="block"><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> implementation that can read from String, StringBuffer,
  153. StringBuilder or CharBuffer.</div>
  154. </td>
  155. </tr>
  156. <tr class="rowColor">
  157. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ClassLoaderObjectInputStream.html" title="class in org.apache.commons.io.input">ClassLoaderObjectInputStream</a></td>
  158. <td class="colLast">
  159. <div class="block">A special ObjectInputStream that loads a class based on a specified
  160. <code>ClassLoader</code> rather than the system default.</div>
  161. </td>
  162. </tr>
  163. <tr class="altColor">
  164. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ClosedInputStream.html" title="class in org.apache.commons.io.input">ClosedInputStream</a></td>
  165. <td class="colLast">
  166. <div class="block">Closed input stream.</div>
  167. </td>
  168. </tr>
  169. <tr class="rowColor">
  170. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/CloseShieldInputStream.html" title="class in org.apache.commons.io.input">CloseShieldInputStream</a></td>
  171. <td class="colLast">
  172. <div class="block">Proxy stream that prevents the underlying input stream from being closed.</div>
  173. </td>
  174. </tr>
  175. <tr class="altColor">
  176. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/CountingInputStream.html" title="class in org.apache.commons.io.input">CountingInputStream</a></td>
  177. <td class="colLast">
  178. <div class="block">A decorating input stream that counts the number of bytes that have passed
  179. through the stream so far.</div>
  180. </td>
  181. </tr>
  182. <tr class="rowColor">
  183. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/DemuxInputStream.html" title="class in org.apache.commons.io.input">DemuxInputStream</a></td>
  184. <td class="colLast">
  185. <div class="block">Data written to this stream is forwarded to a stream that has been associated
  186. with this thread.</div>
  187. </td>
  188. </tr>
  189. <tr class="altColor">
  190. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/InfiniteCircularInputStream.html" title="class in org.apache.commons.io.input">InfiniteCircularInputStream</a></td>
  191. <td class="colLast">
  192. <div class="block">An <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> that infinitely repeats provided bytes.</div>
  193. </td>
  194. </tr>
  195. <tr class="rowColor">
  196. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" title="class in org.apache.commons.io.input">MessageDigestCalculatingInputStream</a></td>
  197. <td class="colLast">
  198. <div class="block">This class is an example for using an <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a>.</div>
  199. </td>
  200. </tr>
  201. <tr class="altColor">
  202. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver.html" title="class in org.apache.commons.io.input">MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver</a></td>
  203. <td class="colLast">
  204. <div class="block">Maintains the message digest.</div>
  205. </td>
  206. </tr>
  207. <tr class="rowColor">
  208. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/NullInputStream.html" title="class in org.apache.commons.io.input">NullInputStream</a></td>
  209. <td class="colLast">
  210. <div class="block">A functional, light weight <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> that emulates
  211. a stream of a specified size.</div>
  212. </td>
  213. </tr>
  214. <tr class="altColor">
  215. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/NullReader.html" title="class in org.apache.commons.io.input">NullReader</a></td>
  216. <td class="colLast">
  217. <div class="block">A functional, light weight <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> that emulates
  218. a reader of a specified size.</div>
  219. </td>
  220. </tr>
  221. <tr class="rowColor">
  222. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input">ObservableInputStream</a></td>
  223. <td class="colLast">
  224. <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
  225. by other receivers, apart from the thread, which is reading it.</div>
  226. </td>
  227. </tr>
  228. <tr class="altColor">
  229. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a></td>
  230. <td class="colLast">&nbsp;</td>
  231. </tr>
  232. <tr class="rowColor">
  233. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></td>
  234. <td class="colLast">
  235. <div class="block">A Proxy stream which acts as expected, that is it passes the method
  236. calls on to the proxied stream and doesn't change which methods are
  237. being called.</div>
  238. </td>
  239. </tr>
  240. <tr class="altColor">
  241. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ProxyReader.html" title="class in org.apache.commons.io.input">ProxyReader</a></td>
  242. <td class="colLast">
  243. <div class="block">A Proxy stream which acts as expected, that is it passes the method
  244. calls on to the proxied stream and doesn't change which methods are
  245. being called.</div>
  246. </td>
  247. </tr>
  248. <tr class="rowColor">
  249. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input">ReaderInputStream</a></td>
  250. <td class="colLast">
  251. <div class="block"><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> implementation that reads a character stream from a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a>
  252. and transforms it to a byte stream using a specified charset encoding.</div>
  253. </td>
  254. </tr>
  255. <tr class="altColor">
  256. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/ReversedLinesFileReader.html" title="class in org.apache.commons.io.input">ReversedLinesFileReader</a></td>
  257. <td class="colLast">
  258. <div class="block">Reads lines in a file reversely (similar to a BufferedReader, but starting at
  259. the last line).</div>
  260. </td>
  261. </tr>
  262. <tr class="rowColor">
  263. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/SwappedDataInputStream.html" title="class in org.apache.commons.io.input">SwappedDataInputStream</a></td>
  264. <td class="colLast">
  265. <div class="block">DataInput for systems relying on little endian data formats.</div>
  266. </td>
  267. </tr>
  268. <tr class="altColor">
  269. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/TaggedInputStream.html" title="class in org.apache.commons.io.input">TaggedInputStream</a></td>
  270. <td class="colLast">
  271. <div class="block">An input stream decorator that tags potential exceptions so that the
  272. stream that caused the exception can easily be identified.</div>
  273. </td>
  274. </tr>
  275. <tr class="rowColor">
  276. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/Tailer.html" title="class in org.apache.commons.io.input">Tailer</a></td>
  277. <td class="colLast">
  278. <div class="block">Simple implementation of the unix "tail -f" functionality.</div>
  279. </td>
  280. </tr>
  281. <tr class="altColor">
  282. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/TailerListenerAdapter.html" title="class in org.apache.commons.io.input">TailerListenerAdapter</a></td>
  283. <td class="colLast">
  284. <div class="block"><a href="../../../../../org/apache/commons/io/input/TailerListener.html" title="interface in org.apache.commons.io.input"><code>TailerListener</code></a> Adapter.</div>
  285. </td>
  286. </tr>
  287. <tr class="rowColor">
  288. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/TeeInputStream.html" title="class in org.apache.commons.io.input">TeeInputStream</a></td>
  289. <td class="colLast">
  290. <div class="block">InputStream proxy that transparently writes a copy of all bytes read
  291. from the proxied stream to a given OutputStream.</div>
  292. </td>
  293. </tr>
  294. <tr class="altColor">
  295. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/UnixLineEndingInputStream.html" title="class in org.apache.commons.io.input">UnixLineEndingInputStream</a></td>
  296. <td class="colLast">
  297. <div class="block">A filtering input stream that ensures the content will have unix-style line endings, LF.</div>
  298. </td>
  299. </tr>
  300. <tr class="rowColor">
  301. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/WindowsLineEndingInputStream.html" title="class in org.apache.commons.io.input">WindowsLineEndingInputStream</a></td>
  302. <td class="colLast">
  303. <div class="block">A filtering input stream that ensures the content will have windows line endings, CRLF.</div>
  304. </td>
  305. </tr>
  306. <tr class="altColor">
  307. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/XmlStreamReader.html" title="class in org.apache.commons.io.input">XmlStreamReader</a></td>
  308. <td class="colLast">
  309. <div class="block">Character stream that handles all the necessary Voodoo to figure out the
  310. charset encoding of the XML document within the stream.</div>
  311. </td>
  312. </tr>
  313. </tbody>
  314. </table>
  315. </li>
  316. <li class="blockList">
  317. <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
  318. <caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
  319. <tr>
  320. <th class="colFirst" scope="col">Exception</th>
  321. <th class="colLast" scope="col">Description</th>
  322. </tr>
  323. <tbody>
  324. <tr class="altColor">
  325. <td class="colFirst"><a href="../../../../../org/apache/commons/io/input/XmlStreamReaderException.html" title="class in org.apache.commons.io.input">XmlStreamReaderException</a></td>
  326. <td class="colLast">
  327. <div class="block">The XmlStreamReaderException is thrown by the XmlStreamReader constructors if
  328. the charset encoding can not be determined according to the XML 1.0
  329. specification and RFC 3023.</div>
  330. </td>
  331. </tr>
  332. </tbody>
  333. </table>
  334. </li>
  335. </ul>
  336. <a name="package.description">
  337. <!-- -->
  338. </a>
  339. <h2 title="Package org.apache.commons.io.input Description">Package org.apache.commons.io.input Description</h2>
  340. <div class="block"><p>
  341. This package provides implementations of input classes, such as
  342. <code>InputStream</code> and <code>Reader</code>.
  343. </p></div>
  344. </div>
  345. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  346. <div class="bottomNav"><a name="navbar.bottom">
  347. <!-- -->
  348. </a>
  349. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  350. <a name="navbar.bottom.firstrow">
  351. <!-- -->
  352. </a>
  353. <ul class="navList" title="Navigation">
  354. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  355. <li class="navBarCell1Rev">Package</li>
  356. <li>Class</li>
  357. <li><a href="package-use.html">Use</a></li>
  358. <li><a href="package-tree.html">Tree</a></li>
  359. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  360. <li><a href="../../../../../index-all.html">Index</a></li>
  361. <li><a href="../../../../../help-doc.html">Help</a></li>
  362. </ul>
  363. </div>
  364. <div class="subNav">
  365. <ul class="navList">
  366. <li><a href="../../../../../org/apache/commons/io/filefilter/package-summary.html">Prev&nbsp;Package</a></li>
  367. <li><a href="../../../../../org/apache/commons/io/monitor/package-summary.html">Next&nbsp;Package</a></li>
  368. </ul>
  369. <ul class="navList">
  370. <li><a href="../../../../../index.html?org/apache/commons/io/input/package-summary.html" target="_top">Frames</a></li>
  371. <li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
  372. </ul>
  373. <ul class="navList" id="allclasses_navbar_bottom">
  374. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  375. </ul>
  376. <div>
  377. <script type="text/javascript"><!--
  378. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  379. if(window==top) {
  380. allClassesLink.style.display = "block";
  381. }
  382. else {
  383. allClassesLink.style.display = "none";
  384. }
  385. //-->
  386. </script>
  387. </div>
  388. <a name="skip.navbar.bottom">
  389. <!-- -->
  390. </a></div>
  391. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  392. <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>
  393. </body>
  394. </html>