ClosedOutputStream.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  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>ClosedOutputStream (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="ClosedOutputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":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/ClosedOutputStream.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/output/ChunkedWriter.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../../org/apache/commons/io/output/CloseShieldOutputStream.html" title="class in org.apache.commons.io.output"><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/output/ClosedOutputStream.html" target="_top">Frames</a></li>
  57. <li><a href="ClosedOutputStream.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.output</div>
  96. <h2 title="Class ClosedOutputStream" class="title">Class ClosedOutputStream</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/OutputStream.html?is-external=true" title="class or interface in java.io">java.io.OutputStream</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.apache.commons.io.output.ClosedOutputStream</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/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</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">ClosedOutputStream</span>
  122. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></pre>
  123. <div class="block">Closed output stream. This stream throws an exception on all attempts to
  124. write something to the stream.
  125. <p>
  126. Typically uses of this class include testing for corner cases in methods
  127. that accept an output stream and acting as a sentinel value instead of
  128. a <code>null</code> output 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/output/ClosedOutputStream.html" title="class in org.apache.commons.io.output">ClosedOutputStream</a></code></td>
  153. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ClosedOutputStream.html#CLOSED_OUTPUT_STREAM">CLOSED_OUTPUT_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/output/ClosedOutputStream.html#ClosedOutputStream--">ClosedOutputStream</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>void</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ClosedOutputStream.html#flush--">flush</a></span>()</code>
  192. <div class="block">Throws an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> to indicate that the stream is closed.</div>
  193. </td>
  194. </tr>
  195. <tr id="i1" class="rowColor">
  196. <td class="colFirst"><code>void</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ClosedOutputStream.html#write-int-">write</a></span>(int&nbsp;b)</code>
  198. <div class="block">Throws an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> to indicate that the stream is closed.</div>
  199. </td>
  200. </tr>
  201. </table>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods.inherited.from.class.java.io.OutputStream">
  204. <!-- -->
  205. </a>
  206. <h3>Methods inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></h3>
  207. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.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/OutputStream.html?is-external=true#write-byte:A-" title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#write-byte:A-int-int-" title="class or interface in java.io">write</a></code></li>
  208. </ul>
  209. <ul class="blockList">
  210. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  211. <!-- -->
  212. </a>
  213. <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>
  214. <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>
  215. </ul>
  216. </li>
  217. </ul>
  218. </li>
  219. </ul>
  220. </div>
  221. <div class="details">
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <!-- ============ FIELD DETAIL =========== -->
  225. <ul class="blockList">
  226. <li class="blockList"><a name="field.detail">
  227. <!-- -->
  228. </a>
  229. <h3>Field Detail</h3>
  230. <a name="CLOSED_OUTPUT_STREAM">
  231. <!-- -->
  232. </a>
  233. <ul class="blockListLast">
  234. <li class="blockList">
  235. <h4>CLOSED_OUTPUT_STREAM</h4>
  236. <pre>public static final&nbsp;<a href="../../../../../org/apache/commons/io/output/ClosedOutputStream.html" title="class in org.apache.commons.io.output">ClosedOutputStream</a> CLOSED_OUTPUT_STREAM</pre>
  237. <div class="block">A singleton.</div>
  238. </li>
  239. </ul>
  240. </li>
  241. </ul>
  242. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  243. <ul class="blockList">
  244. <li class="blockList"><a name="constructor.detail">
  245. <!-- -->
  246. </a>
  247. <h3>Constructor Detail</h3>
  248. <a name="ClosedOutputStream--">
  249. <!-- -->
  250. </a>
  251. <ul class="blockListLast">
  252. <li class="blockList">
  253. <h4>ClosedOutputStream</h4>
  254. <pre>public&nbsp;ClosedOutputStream()</pre>
  255. </li>
  256. </ul>
  257. </li>
  258. </ul>
  259. <!-- ============ METHOD DETAIL ========== -->
  260. <ul class="blockList">
  261. <li class="blockList"><a name="method.detail">
  262. <!-- -->
  263. </a>
  264. <h3>Method Detail</h3>
  265. <a name="write-int-">
  266. <!-- -->
  267. </a>
  268. <ul class="blockList">
  269. <li class="blockList">
  270. <h4>write</h4>
  271. <pre>public&nbsp;void&nbsp;write(int&nbsp;b)
  272. 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>
  273. <div class="block">Throws an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> to indicate that the stream is closed.</div>
  274. <dl>
  275. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  276. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#write-int-" title="class or interface in java.io">write</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></dd>
  277. <dt><span class="paramLabel">Parameters:</span></dt>
  278. <dd><code>b</code> - ignored</dd>
  279. <dt><span class="throwsLabel">Throws:</span></dt>
  280. <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> - always thrown</dd>
  281. </dl>
  282. </li>
  283. </ul>
  284. <a name="flush--">
  285. <!-- -->
  286. </a>
  287. <ul class="blockListLast">
  288. <li class="blockList">
  289. <h4>flush</h4>
  290. <pre>public&nbsp;void&nbsp;flush()
  291. 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>
  292. <div class="block">Throws an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> to indicate that the stream is closed.</div>
  293. <dl>
  294. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  295. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true#flush--" title="class or interface in java.io">flush</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true" title="class or interface in java.io">Flushable</a></code></dd>
  296. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  297. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true#flush--" title="class or interface in java.io">flush</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></dd>
  298. <dt><span class="throwsLabel">Throws:</span></dt>
  299. <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> - always thrown</dd>
  300. </dl>
  301. </li>
  302. </ul>
  303. </li>
  304. </ul>
  305. </li>
  306. </ul>
  307. </div>
  308. </div>
  309. <!-- ========= END OF CLASS DATA ========= -->
  310. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  311. <div class="bottomNav"><a name="navbar.bottom">
  312. <!-- -->
  313. </a>
  314. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  315. <a name="navbar.bottom.firstrow">
  316. <!-- -->
  317. </a>
  318. <ul class="navList" title="Navigation">
  319. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  320. <li><a href="package-summary.html">Package</a></li>
  321. <li class="navBarCell1Rev">Class</li>
  322. <li><a href="class-use/ClosedOutputStream.html">Use</a></li>
  323. <li><a href="package-tree.html">Tree</a></li>
  324. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  325. <li><a href="../../../../../index-all.html">Index</a></li>
  326. <li><a href="../../../../../help-doc.html">Help</a></li>
  327. </ul>
  328. </div>
  329. <div class="subNav">
  330. <ul class="navList">
  331. <li><a href="../../../../../org/apache/commons/io/output/ChunkedWriter.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  332. <li><a href="../../../../../org/apache/commons/io/output/CloseShieldOutputStream.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  333. </ul>
  334. <ul class="navList">
  335. <li><a href="../../../../../index.html?org/apache/commons/io/output/ClosedOutputStream.html" target="_top">Frames</a></li>
  336. <li><a href="ClosedOutputStream.html" target="_top">No&nbsp;Frames</a></li>
  337. </ul>
  338. <ul class="navList" id="allclasses_navbar_bottom">
  339. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  340. </ul>
  341. <div>
  342. <script type="text/javascript"><!--
  343. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  344. if(window==top) {
  345. allClassesLink.style.display = "block";
  346. }
  347. else {
  348. allClassesLink.style.display = "none";
  349. }
  350. //-->
  351. </script>
  352. </div>
  353. <div>
  354. <ul class="subNavList">
  355. <li>Summary:&nbsp;</li>
  356. <li>Nested&nbsp;|&nbsp;</li>
  357. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  358. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  359. <li><a href="#method.summary">Method</a></li>
  360. </ul>
  361. <ul class="subNavList">
  362. <li>Detail:&nbsp;</li>
  363. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  364. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  365. <li><a href="#method.detail">Method</a></li>
  366. </ul>
  367. </div>
  368. <a name="skip.navbar.bottom">
  369. <!-- -->
  370. </a></div>
  371. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  372. <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>
  373. </body>
  374. </html>