ReaderInputStream.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
  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>ReaderInputStream (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="ReaderInputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":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/ReaderInputStream.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/ProxyReader.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/ReversedLinesFileReader.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/ReaderInputStream.html" target="_top">Frames</a></li>
  57. <li><a href="ReaderInputStream.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>Field&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 ReaderInputStream" class="title">Class ReaderInputStream</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>org.apache.commons.io.input.ReaderInputStream</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <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>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <span class="typeNameLabel">ReaderInputStream</span>
  122. extends <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></pre>
  123. <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>
  124. and transforms it to a byte stream using a specified charset encoding. The stream
  125. is transformed using a <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/CharsetEncoder.html?is-external=true" title="class or interface in java.nio.charset"><code>CharsetEncoder</code></a> object, guaranteeing that all charset
  126. encodings supported by the JRE are handled correctly. In particular for charsets such as
  127. UTF-16, the implementation ensures that one and only one byte order marker
  128. is produced.
  129. <p>
  130. Since in general it is not possible to predict the number of characters to be read from the
  131. <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> to satisfy a read request on the <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>, all reads from
  132. the <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> are buffered. There is therefore no well defined correlation
  133. between the current position of the <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> and that of the <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.
  134. This also implies that in general there is no need to wrap the underlying <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>
  135. in a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/BufferedReader.html?is-external=true" title="class or interface in java.io"><code>BufferedReader</code></a>.
  136. <p>
  137. <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> implements the inverse transformation of <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStreamReader.html?is-external=true" title="class or interface in java.io"><code>InputStreamReader</code></a>;
  138. in the following example, reading from <code>in2</code> would return the same byte
  139. sequence as reading from <code>in</code> (provided that the initial byte sequence is legal
  140. with respect to the charset encoding):
  141. <pre>
  142. InputStream in = ...
  143. Charset cs = ...
  144. InputStreamReader reader = new InputStreamReader(in, cs);
  145. ReaderInputStream in2 = new ReaderInputStream(reader, cs);</pre>
  146. <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> implements the same transformation as <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStreamWriter.html?is-external=true" title="class or interface in java.io"><code>OutputStreamWriter</code></a>,
  147. except that the control flow is reversed: both classes transform a character stream
  148. into a byte stream, but <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStreamWriter.html?is-external=true" title="class or interface in java.io"><code>OutputStreamWriter</code></a> pushes data to the underlying stream,
  149. while <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> pulls it from the underlying stream.
  150. <p>
  151. Note that while there are use cases where there is no alternative to using
  152. this class, very often the need to use this class is an indication of a flaw
  153. in the design of the code. This class is typically used in situations where an existing
  154. API only accepts 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>, but where the most natural way to produce the data
  155. is as a character stream, i.e. by providing 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> instance. An example of a situation
  156. where this problem may appear is when implementing the <code>javax.activation.DataSource</code>
  157. interface from the Java Activation Framework.
  158. <p>
  159. Given the fact that the <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> class doesn't provide any way to predict whether the next
  160. read operation will block or not, it is not possible to provide a meaningful
  161. implementation of the <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#available--" title="class or interface in java.io"><code>InputStream.available()</code></a> method. A call to this method
  162. will always return 0. Also, this class doesn't support <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#mark-int-" title="class or interface in java.io"><code>InputStream.mark(int)</code></a>.
  163. <p>
  164. Instances of <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> are not thread safe.</div>
  165. <dl>
  166. <dt><span class="simpleTagLabel">Since:</span></dt>
  167. <dd>2.0</dd>
  168. <dt><span class="seeLabel">See Also:</span></dt>
  169. <dd><a href="../../../../../org/apache/commons/io/output/WriterOutputStream.html" title="class in org.apache.commons.io.output"><code>WriterOutputStream</code></a></dd>
  170. </dl>
  171. </li>
  172. </ul>
  173. </div>
  174. <div class="summary">
  175. <ul class="blockList">
  176. <li class="blockList">
  177. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  178. <ul class="blockList">
  179. <li class="blockList"><a name="constructor.summary">
  180. <!-- -->
  181. </a>
  182. <h3>Constructor Summary</h3>
  183. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  184. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  185. <tr>
  186. <th class="colOne" scope="col">Constructor and Description</th>
  187. </tr>
  188. <tr class="altColor">
  189. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-">ReaderInputStream</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;reader)</code>
  190. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  191. <div class="block"><span class="deprecationComment">2.5 use <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.nio.charset.Charset-"><code>ReaderInputStream(Reader, Charset)</code></a> instead</span></div>
  192. </div>
  193. </td>
  194. </tr>
  195. <tr class="rowColor">
  196. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.nio.charset.Charset-">ReaderInputStream</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;reader,
  197. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset)</code>
  198. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> with a default input buffer size of
  199. 1024 characters.</div>
  200. </td>
  201. </tr>
  202. <tr class="altColor">
  203. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.nio.charset.CharsetEncoder-">ReaderInputStream</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;reader,
  204. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/CharsetEncoder.html?is-external=true" title="class or interface in java.nio.charset">CharsetEncoder</a>&nbsp;encoder)</code>
  205. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  206. </td>
  207. </tr>
  208. <tr class="rowColor">
  209. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.nio.charset.CharsetEncoder-int-">ReaderInputStream</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;reader,
  210. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/CharsetEncoder.html?is-external=true" title="class or interface in java.nio.charset">CharsetEncoder</a>&nbsp;encoder,
  211. int&nbsp;bufferSize)</code>
  212. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  213. </td>
  214. </tr>
  215. <tr class="altColor">
  216. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.nio.charset.Charset-int-">ReaderInputStream</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;reader,
  217. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset,
  218. int&nbsp;bufferSize)</code>
  219. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  220. </td>
  221. </tr>
  222. <tr class="rowColor">
  223. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.lang.String-">ReaderInputStream</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;reader,
  224. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName)</code>
  225. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> with a default input buffer size of
  226. 1024 characters.</div>
  227. </td>
  228. </tr>
  229. <tr class="altColor">
  230. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.lang.String-int-">ReaderInputStream</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;reader,
  231. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName,
  232. int&nbsp;bufferSize)</code>
  233. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  234. </td>
  235. </tr>
  236. </table>
  237. </li>
  238. </ul>
  239. <!-- ========== METHOD SUMMARY =========== -->
  240. <ul class="blockList">
  241. <li class="blockList"><a name="method.summary">
  242. <!-- -->
  243. </a>
  244. <h3>Method Summary</h3>
  245. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  246. <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>
  247. <tr>
  248. <th class="colFirst" scope="col">Modifier and Type</th>
  249. <th class="colLast" scope="col">Method and Description</th>
  250. </tr>
  251. <tr id="i0" class="altColor">
  252. <td class="colFirst"><code>void</code></td>
  253. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#close--">close</a></span>()</code>
  254. <div class="block">Close the stream.</div>
  255. </td>
  256. </tr>
  257. <tr id="i1" class="rowColor">
  258. <td class="colFirst"><code>int</code></td>
  259. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#read--">read</a></span>()</code>
  260. <div class="block">Read a single byte.</div>
  261. </td>
  262. </tr>
  263. <tr id="i2" class="altColor">
  264. <td class="colFirst"><code>int</code></td>
  265. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#read-byte:A-">read</a></span>(byte[]&nbsp;b)</code>
  266. <div class="block">Read the specified number of bytes into an array.</div>
  267. </td>
  268. </tr>
  269. <tr id="i3" class="rowColor">
  270. <td class="colFirst"><code>int</code></td>
  271. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#read-byte:A-int-int-">read</a></span>(byte[]&nbsp;b,
  272. int&nbsp;off,
  273. int&nbsp;len)</code>
  274. <div class="block">Read the specified number of bytes into an array.</div>
  275. </td>
  276. </tr>
  277. </table>
  278. <ul class="blockList">
  279. <li class="blockList"><a name="methods.inherited.from.class.java.io.InputStream">
  280. <!-- -->
  281. </a>
  282. <h3>Methods inherited from class&nbsp;java.io.<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></h3>
  283. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#available--" title="class or interface in java.io">available</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#mark-int-" title="class or interface in java.io">mark</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#markSupported--" title="class or interface in java.io">markSupported</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#reset--" title="class or interface in java.io">reset</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#skip-long-" title="class or interface in java.io">skip</a></code></li>
  284. </ul>
  285. <ul class="blockList">
  286. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  287. <!-- -->
  288. </a>
  289. <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>
  290. <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>
  291. </ul>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. </div>
  297. <div class="details">
  298. <ul class="blockList">
  299. <li class="blockList">
  300. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  301. <ul class="blockList">
  302. <li class="blockList"><a name="constructor.detail">
  303. <!-- -->
  304. </a>
  305. <h3>Constructor Detail</h3>
  306. <a name="ReaderInputStream-java.io.Reader-java.nio.charset.CharsetEncoder-">
  307. <!-- -->
  308. </a>
  309. <ul class="blockList">
  310. <li class="blockList">
  311. <h4>ReaderInputStream</h4>
  312. <pre>public&nbsp;ReaderInputStream(<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;reader,
  313. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/CharsetEncoder.html?is-external=true" title="class or interface in java.nio.charset">CharsetEncoder</a>&nbsp;encoder)</pre>
  314. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  315. <dl>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>reader</code> - the target <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></dd>
  318. <dd><code>encoder</code> - the charset encoder</dd>
  319. <dt><span class="simpleTagLabel">Since:</span></dt>
  320. <dd>2.1</dd>
  321. </dl>
  322. </li>
  323. </ul>
  324. <a name="ReaderInputStream-java.io.Reader-java.nio.charset.CharsetEncoder-int-">
  325. <!-- -->
  326. </a>
  327. <ul class="blockList">
  328. <li class="blockList">
  329. <h4>ReaderInputStream</h4>
  330. <pre>public&nbsp;ReaderInputStream(<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;reader,
  331. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/CharsetEncoder.html?is-external=true" title="class or interface in java.nio.charset">CharsetEncoder</a>&nbsp;encoder,
  332. int&nbsp;bufferSize)</pre>
  333. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  334. <dl>
  335. <dt><span class="paramLabel">Parameters:</span></dt>
  336. <dd><code>reader</code> - the target <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></dd>
  337. <dd><code>encoder</code> - the charset encoder</dd>
  338. <dd><code>bufferSize</code> - the size of the input buffer in number of characters</dd>
  339. <dt><span class="simpleTagLabel">Since:</span></dt>
  340. <dd>2.1</dd>
  341. </dl>
  342. </li>
  343. </ul>
  344. <a name="ReaderInputStream-java.io.Reader-java.nio.charset.Charset-int-">
  345. <!-- -->
  346. </a>
  347. <ul class="blockList">
  348. <li class="blockList">
  349. <h4>ReaderInputStream</h4>
  350. <pre>public&nbsp;ReaderInputStream(<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;reader,
  351. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset,
  352. int&nbsp;bufferSize)</pre>
  353. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  354. <dl>
  355. <dt><span class="paramLabel">Parameters:</span></dt>
  356. <dd><code>reader</code> - the target <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></dd>
  357. <dd><code>charset</code> - the charset encoding</dd>
  358. <dd><code>bufferSize</code> - the size of the input buffer in number of characters</dd>
  359. </dl>
  360. </li>
  361. </ul>
  362. <a name="ReaderInputStream-java.io.Reader-java.nio.charset.Charset-">
  363. <!-- -->
  364. </a>
  365. <ul class="blockList">
  366. <li class="blockList">
  367. <h4>ReaderInputStream</h4>
  368. <pre>public&nbsp;ReaderInputStream(<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;reader,
  369. <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset)</pre>
  370. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> with a default input buffer size of
  371. 1024 characters.</div>
  372. <dl>
  373. <dt><span class="paramLabel">Parameters:</span></dt>
  374. <dd><code>reader</code> - the target <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></dd>
  375. <dd><code>charset</code> - the charset encoding</dd>
  376. </dl>
  377. </li>
  378. </ul>
  379. <a name="ReaderInputStream-java.io.Reader-java.lang.String-int-">
  380. <!-- -->
  381. </a>
  382. <ul class="blockList">
  383. <li class="blockList">
  384. <h4>ReaderInputStream</h4>
  385. <pre>public&nbsp;ReaderInputStream(<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;reader,
  386. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName,
  387. int&nbsp;bufferSize)</pre>
  388. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a>.</div>
  389. <dl>
  390. <dt><span class="paramLabel">Parameters:</span></dt>
  391. <dd><code>reader</code> - the target <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></dd>
  392. <dd><code>charsetName</code> - the name of the charset encoding</dd>
  393. <dd><code>bufferSize</code> - the size of the input buffer in number of characters</dd>
  394. </dl>
  395. </li>
  396. </ul>
  397. <a name="ReaderInputStream-java.io.Reader-java.lang.String-">
  398. <!-- -->
  399. </a>
  400. <ul class="blockList">
  401. <li class="blockList">
  402. <h4>ReaderInputStream</h4>
  403. <pre>public&nbsp;ReaderInputStream(<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;reader,
  404. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName)</pre>
  405. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> with a default input buffer size of
  406. 1024 characters.</div>
  407. <dl>
  408. <dt><span class="paramLabel">Parameters:</span></dt>
  409. <dd><code>reader</code> - the target <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></dd>
  410. <dd><code>charsetName</code> - the name of the charset encoding</dd>
  411. </dl>
  412. </li>
  413. </ul>
  414. <a name="ReaderInputStream-java.io.Reader-">
  415. <!-- -->
  416. </a>
  417. <ul class="blockListLast">
  418. <li class="blockList">
  419. <h4>ReaderInputStream</h4>
  420. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  421. public&nbsp;ReaderInputStream(<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;reader)</pre>
  422. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">2.5 use <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html#ReaderInputStream-java.io.Reader-java.nio.charset.Charset-"><code>ReaderInputStream(Reader, Charset)</code></a> instead</span></div>
  423. <div class="block">Construct a new <a href="../../../../../org/apache/commons/io/input/ReaderInputStream.html" title="class in org.apache.commons.io.input"><code>ReaderInputStream</code></a> that uses the default character encoding
  424. with a default input buffer size of 1024 characters.</div>
  425. <dl>
  426. <dt><span class="paramLabel">Parameters:</span></dt>
  427. <dd><code>reader</code> - the target <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></dd>
  428. </dl>
  429. </li>
  430. </ul>
  431. </li>
  432. </ul>
  433. <!-- ============ METHOD DETAIL ========== -->
  434. <ul class="blockList">
  435. <li class="blockList"><a name="method.detail">
  436. <!-- -->
  437. </a>
  438. <h3>Method Detail</h3>
  439. <a name="read-byte:A-int-int-">
  440. <!-- -->
  441. </a>
  442. <ul class="blockList">
  443. <li class="blockList">
  444. <h4>read</h4>
  445. <pre>public&nbsp;int&nbsp;read(byte[]&nbsp;b,
  446. int&nbsp;off,
  447. int&nbsp;len)
  448. 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>
  449. <div class="block">Read the specified number of bytes into an array.</div>
  450. <dl>
  451. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  452. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read-byte: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/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  453. <dt><span class="paramLabel">Parameters:</span></dt>
  454. <dd><code>b</code> - the byte array to read into</dd>
  455. <dd><code>off</code> - the offset to start reading bytes into</dd>
  456. <dd><code>len</code> - the number of bytes to read</dd>
  457. <dt><span class="returnLabel">Returns:</span></dt>
  458. <dd>the number of bytes read or <code>-1</code>
  459. if the end of the stream has been reached</dd>
  460. <dt><span class="throwsLabel">Throws:</span></dt>
  461. <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>
  462. </dl>
  463. </li>
  464. </ul>
  465. <a name="read-byte:A-">
  466. <!-- -->
  467. </a>
  468. <ul class="blockList">
  469. <li class="blockList">
  470. <h4>read</h4>
  471. <pre>public&nbsp;int&nbsp;read(byte[]&nbsp;b)
  472. 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>
  473. <div class="block">Read the specified number of bytes into an array.</div>
  474. <dl>
  475. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  476. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#read-byte: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/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  477. <dt><span class="paramLabel">Parameters:</span></dt>
  478. <dd><code>b</code> - the byte array to read into</dd>
  479. <dt><span class="returnLabel">Returns:</span></dt>
  480. <dd>the number of bytes read or <code>-1</code>
  481. if the end of the stream has been reached</dd>
  482. <dt><span class="throwsLabel">Throws:</span></dt>
  483. <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>
  484. </dl>
  485. </li>
  486. </ul>
  487. <a name="read--">
  488. <!-- -->
  489. </a>
  490. <ul class="blockList">
  491. <li class="blockList">
  492. <h4>read</h4>
  493. <pre>public&nbsp;int&nbsp;read()
  494. 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>
  495. <div class="block">Read a single byte.</div>
  496. <dl>
  497. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  498. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.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/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  499. <dt><span class="returnLabel">Returns:</span></dt>
  500. <dd>either the byte read or <code>-1</code> if the end of the stream
  501. has been reached</dd>
  502. <dt><span class="throwsLabel">Throws:</span></dt>
  503. <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>
  504. </dl>
  505. </li>
  506. </ul>
  507. <a name="close--">
  508. <!-- -->
  509. </a>
  510. <ul class="blockListLast">
  511. <li class="blockList">
  512. <h4>close</h4>
  513. <pre>public&nbsp;void&nbsp;close()
  514. 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>
  515. <div class="block">Close the stream. This method will cause the underlying <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>
  516. to be closed.</div>
  517. <dl>
  518. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  519. <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>
  520. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  521. <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>
  522. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  523. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.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/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  524. <dt><span class="throwsLabel">Throws:</span></dt>
  525. <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>
  526. </dl>
  527. </li>
  528. </ul>
  529. </li>
  530. </ul>
  531. </li>
  532. </ul>
  533. </div>
  534. </div>
  535. <!-- ========= END OF CLASS DATA ========= -->
  536. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  537. <div class="bottomNav"><a name="navbar.bottom">
  538. <!-- -->
  539. </a>
  540. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  541. <a name="navbar.bottom.firstrow">
  542. <!-- -->
  543. </a>
  544. <ul class="navList" title="Navigation">
  545. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  546. <li><a href="package-summary.html">Package</a></li>
  547. <li class="navBarCell1Rev">Class</li>
  548. <li><a href="class-use/ReaderInputStream.html">Use</a></li>
  549. <li><a href="package-tree.html">Tree</a></li>
  550. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  551. <li><a href="../../../../../index-all.html">Index</a></li>
  552. <li><a href="../../../../../help-doc.html">Help</a></li>
  553. </ul>
  554. </div>
  555. <div class="subNav">
  556. <ul class="navList">
  557. <li><a href="../../../../../org/apache/commons/io/input/ProxyReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  558. <li><a href="../../../../../org/apache/commons/io/input/ReversedLinesFileReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  559. </ul>
  560. <ul class="navList">
  561. <li><a href="../../../../../index.html?org/apache/commons/io/input/ReaderInputStream.html" target="_top">Frames</a></li>
  562. <li><a href="ReaderInputStream.html" target="_top">No&nbsp;Frames</a></li>
  563. </ul>
  564. <ul class="navList" id="allclasses_navbar_bottom">
  565. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  566. </ul>
  567. <div>
  568. <script type="text/javascript"><!--
  569. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  570. if(window==top) {
  571. allClassesLink.style.display = "block";
  572. }
  573. else {
  574. allClassesLink.style.display = "none";
  575. }
  576. //-->
  577. </script>
  578. </div>
  579. <div>
  580. <ul class="subNavList">
  581. <li>Summary:&nbsp;</li>
  582. <li>Nested&nbsp;|&nbsp;</li>
  583. <li>Field&nbsp;|&nbsp;</li>
  584. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  585. <li><a href="#method.summary">Method</a></li>
  586. </ul>
  587. <ul class="subNavList">
  588. <li>Detail:&nbsp;</li>
  589. <li>Field&nbsp;|&nbsp;</li>
  590. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  591. <li><a href="#method.detail">Method</a></li>
  592. </ul>
  593. </div>
  594. <a name="skip.navbar.bottom">
  595. <!-- -->
  596. </a></div>
  597. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  598. <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>
  599. </body>
  600. </html>