ClosedInputStream.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  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>ClosedInputStream (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="ClosedInputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":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/ClosedInputStream.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/ClassLoaderObjectInputStream.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/CloseShieldInputStream.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/ClosedInputStream.html" target="_top">Frames</a></li>
  57. <li><a href="ClosedInputStream.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#field.summary">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><a href="#field.detail">Field</a>&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 ClosedInputStream" class="title">Class ClosedInputStream</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.ClosedInputStream</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">ClosedInputStream</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">Closed input stream. This stream returns EOF to all attempts to read
  124. something from the stream.
  125. <p>
  126. Typically uses of this class include testing for corner cases in methods
  127. that accept input streams and acting as a sentinel value instead of a
  128. <code>null</code> input stream.</div>
  129. <dl>
  130. <dt><span class="simpleTagLabel">Since:</span></dt>
  131. <dd>1.4</dd>
  132. </dl>
  133. </li>
  134. </ul>
  135. </div>
  136. <div class="summary">
  137. <ul class="blockList">
  138. <li class="blockList">
  139. <!-- =========== FIELD SUMMARY =========== -->
  140. <ul class="blockList">
  141. <li class="blockList"><a name="field.summary">
  142. <!-- -->
  143. </a>
  144. <h3>Field Summary</h3>
  145. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  146. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  147. <tr>
  148. <th class="colFirst" scope="col">Modifier and Type</th>
  149. <th class="colLast" scope="col">Field and Description</th>
  150. </tr>
  151. <tr class="altColor">
  152. <td class="colFirst"><code>static <a href="../../../../../org/apache/commons/io/input/ClosedInputStream.html" title="class in org.apache.commons.io.input">ClosedInputStream</a></code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ClosedInputStream.html#CLOSED_INPUT_STREAM">CLOSED_INPUT_STREAM</a></span></code>
  154. <div class="block">A singleton.</div>
  155. </td>
  156. </tr>
  157. </table>
  158. </li>
  159. </ul>
  160. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  161. <ul class="blockList">
  162. <li class="blockList"><a name="constructor.summary">
  163. <!-- -->
  164. </a>
  165. <h3>Constructor Summary</h3>
  166. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  167. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  168. <tr>
  169. <th class="colOne" scope="col">Constructor and Description</th>
  170. </tr>
  171. <tr class="altColor">
  172. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ClosedInputStream.html#ClosedInputStream--">ClosedInputStream</a></span>()</code>&nbsp;</td>
  173. </tr>
  174. </table>
  175. </li>
  176. </ul>
  177. <!-- ========== METHOD SUMMARY =========== -->
  178. <ul class="blockList">
  179. <li class="blockList"><a name="method.summary">
  180. <!-- -->
  181. </a>
  182. <h3>Method Summary</h3>
  183. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  184. <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>
  185. <tr>
  186. <th class="colFirst" scope="col">Modifier and Type</th>
  187. <th class="colLast" scope="col">Method and Description</th>
  188. </tr>
  189. <tr id="i0" class="altColor">
  190. <td class="colFirst"><code>int</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ClosedInputStream.html#read--">read</a></span>()</code>
  192. <div class="block">Returns -1 to indicate that the stream is closed.</div>
  193. </td>
  194. </tr>
  195. </table>
  196. <ul class="blockList">
  197. <li class="blockList"><a name="methods.inherited.from.class.java.io.InputStream">
  198. <!-- -->
  199. </a>
  200. <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>
  201. <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#close--" title="class or interface in java.io">close</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#read-byte:A-" title="class or interface in java.io">read</a>, <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>, <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>
  202. </ul>
  203. <ul class="blockList">
  204. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  205. <!-- -->
  206. </a>
  207. <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>
  208. <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>
  209. </ul>
  210. </li>
  211. </ul>
  212. </li>
  213. </ul>
  214. </div>
  215. <div class="details">
  216. <ul class="blockList">
  217. <li class="blockList">
  218. <!-- ============ FIELD DETAIL =========== -->
  219. <ul class="blockList">
  220. <li class="blockList"><a name="field.detail">
  221. <!-- -->
  222. </a>
  223. <h3>Field Detail</h3>
  224. <a name="CLOSED_INPUT_STREAM">
  225. <!-- -->
  226. </a>
  227. <ul class="blockListLast">
  228. <li class="blockList">
  229. <h4>CLOSED_INPUT_STREAM</h4>
  230. <pre>public static final&nbsp;<a href="../../../../../org/apache/commons/io/input/ClosedInputStream.html" title="class in org.apache.commons.io.input">ClosedInputStream</a> CLOSED_INPUT_STREAM</pre>
  231. <div class="block">A singleton.</div>
  232. </li>
  233. </ul>
  234. </li>
  235. </ul>
  236. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  237. <ul class="blockList">
  238. <li class="blockList"><a name="constructor.detail">
  239. <!-- -->
  240. </a>
  241. <h3>Constructor Detail</h3>
  242. <a name="ClosedInputStream--">
  243. <!-- -->
  244. </a>
  245. <ul class="blockListLast">
  246. <li class="blockList">
  247. <h4>ClosedInputStream</h4>
  248. <pre>public&nbsp;ClosedInputStream()</pre>
  249. </li>
  250. </ul>
  251. </li>
  252. </ul>
  253. <!-- ============ METHOD DETAIL ========== -->
  254. <ul class="blockList">
  255. <li class="blockList"><a name="method.detail">
  256. <!-- -->
  257. </a>
  258. <h3>Method Detail</h3>
  259. <a name="read--">
  260. <!-- -->
  261. </a>
  262. <ul class="blockListLast">
  263. <li class="blockList">
  264. <h4>read</h4>
  265. <pre>public&nbsp;int&nbsp;read()</pre>
  266. <div class="block">Returns -1 to indicate that the stream is closed.</div>
  267. <dl>
  268. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  269. <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>
  270. <dt><span class="returnLabel">Returns:</span></dt>
  271. <dd>always -1</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. </li>
  276. </ul>
  277. </li>
  278. </ul>
  279. </div>
  280. </div>
  281. <!-- ========= END OF CLASS DATA ========= -->
  282. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  283. <div class="bottomNav"><a name="navbar.bottom">
  284. <!-- -->
  285. </a>
  286. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  287. <a name="navbar.bottom.firstrow">
  288. <!-- -->
  289. </a>
  290. <ul class="navList" title="Navigation">
  291. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  292. <li><a href="package-summary.html">Package</a></li>
  293. <li class="navBarCell1Rev">Class</li>
  294. <li><a href="class-use/ClosedInputStream.html">Use</a></li>
  295. <li><a href="package-tree.html">Tree</a></li>
  296. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  297. <li><a href="../../../../../index-all.html">Index</a></li>
  298. <li><a href="../../../../../help-doc.html">Help</a></li>
  299. </ul>
  300. </div>
  301. <div class="subNav">
  302. <ul class="navList">
  303. <li><a href="../../../../../org/apache/commons/io/input/ClassLoaderObjectInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  304. <li><a href="../../../../../org/apache/commons/io/input/CloseShieldInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  305. </ul>
  306. <ul class="navList">
  307. <li><a href="../../../../../index.html?org/apache/commons/io/input/ClosedInputStream.html" target="_top">Frames</a></li>
  308. <li><a href="ClosedInputStream.html" target="_top">No&nbsp;Frames</a></li>
  309. </ul>
  310. <ul class="navList" id="allclasses_navbar_bottom">
  311. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  312. </ul>
  313. <div>
  314. <script type="text/javascript"><!--
  315. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  316. if(window==top) {
  317. allClassesLink.style.display = "block";
  318. }
  319. else {
  320. allClassesLink.style.display = "none";
  321. }
  322. //-->
  323. </script>
  324. </div>
  325. <div>
  326. <ul class="subNavList">
  327. <li>Summary:&nbsp;</li>
  328. <li>Nested&nbsp;|&nbsp;</li>
  329. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  330. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  331. <li><a href="#method.summary">Method</a></li>
  332. </ul>
  333. <ul class="subNavList">
  334. <li>Detail:&nbsp;</li>
  335. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  336. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  337. <li><a href="#method.detail">Method</a></li>
  338. </ul>
  339. </div>
  340. <a name="skip.navbar.bottom">
  341. <!-- -->
  342. </a></div>
  343. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  344. <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>
  345. </body>
  346. </html>