ProxyOutputStream.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531
  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>ProxyOutputStream (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="ProxyOutputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
  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/ProxyOutputStream.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/NullWriter.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/ProxyWriter.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/ProxyOutputStream.html" target="_top">Frames</a></li>
  57. <li><a href="ProxyOutputStream.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="#fields.inherited.from.class.java.io.FilterOutputStream">Field</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io.output</div>
  96. <h2 title="Class ProxyOutputStream" class="title">Class ProxyOutputStream</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><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.html?is-external=true" title="class or interface in java.io">java.io.FilterOutputStream</a></li>
  107. <li>
  108. <ul class="inheritance">
  109. <li>org.apache.commons.io.output.ProxyOutputStream</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <dl>
  121. <dt>All Implemented Interfaces:</dt>
  122. <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>
  123. </dl>
  124. <dl>
  125. <dt>Direct Known Subclasses:</dt>
  126. <dd><a href="../../../../../org/apache/commons/io/output/CloseShieldOutputStream.html" title="class in org.apache.commons.io.output">CloseShieldOutputStream</a>, <a href="../../../../../org/apache/commons/io/output/CountingOutputStream.html" title="class in org.apache.commons.io.output">CountingOutputStream</a>, <a href="../../../../../org/apache/commons/io/output/TaggedOutputStream.html" title="class in org.apache.commons.io.output">TaggedOutputStream</a>, <a href="../../../../../org/apache/commons/io/output/TeeOutputStream.html" title="class in org.apache.commons.io.output">TeeOutputStream</a></dd>
  127. </dl>
  128. <hr>
  129. <br>
  130. <pre>public class <span class="typeNameLabel">ProxyOutputStream</span>
  131. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></pre>
  132. <div class="block">A Proxy stream which acts as expected, that is it passes the method
  133. calls on to the proxied stream and doesn't change which methods are
  134. being called. It is an alternative base class to FilterOutputStream
  135. to increase reusability.
  136. <p>
  137. See the protected methods for ways in which a subclass can easily decorate
  138. a stream with custom pre-, post- or error processing functionality.</div>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="summary">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- =========== FIELD SUMMARY =========== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="field.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Field Summary</h3>
  151. <ul class="blockList">
  152. <li class="blockList"><a name="fields.inherited.from.class.java.io.FilterOutputStream">
  153. <!-- -->
  154. </a>
  155. <h3>Fields inherited from class&nbsp;java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></h3>
  156. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.html?is-external=true#out" title="class or interface in java.io">out</a></code></li>
  157. </ul>
  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/ProxyOutputStream.html#ProxyOutputStream-java.io.OutputStream-">ProxyOutputStream</a></span>(<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>&nbsp;proxy)</code>
  173. <div class="block">Constructs a new ProxyOutputStream.</div>
  174. </td>
  175. </tr>
  176. </table>
  177. </li>
  178. </ul>
  179. <!-- ========== METHOD SUMMARY =========== -->
  180. <ul class="blockList">
  181. <li class="blockList"><a name="method.summary">
  182. <!-- -->
  183. </a>
  184. <h3>Method Summary</h3>
  185. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  186. <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>
  187. <tr>
  188. <th class="colFirst" scope="col">Modifier and Type</th>
  189. <th class="colLast" scope="col">Method and Description</th>
  190. </tr>
  191. <tr id="i0" class="altColor">
  192. <td class="colFirst"><code>protected void</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#afterWrite-int-">afterWrite</a></span>(int&nbsp;n)</code>
  194. <div class="block">Invoked by the write methods after the proxied call has returned
  195. successfully.</div>
  196. </td>
  197. </tr>
  198. <tr id="i1" class="rowColor">
  199. <td class="colFirst"><code>protected void</code></td>
  200. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#beforeWrite-int-">beforeWrite</a></span>(int&nbsp;n)</code>
  201. <div class="block">Invoked by the write methods before the call is proxied.</div>
  202. </td>
  203. </tr>
  204. <tr id="i2" class="altColor">
  205. <td class="colFirst"><code>void</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#close--">close</a></span>()</code>
  207. <div class="block">Invokes the delegate's <code>close()</code> method.</div>
  208. </td>
  209. </tr>
  210. <tr id="i3" class="rowColor">
  211. <td class="colFirst"><code>void</code></td>
  212. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#flush--">flush</a></span>()</code>
  213. <div class="block">Invokes the delegate's <code>flush()</code> method.</div>
  214. </td>
  215. </tr>
  216. <tr id="i4" class="altColor">
  217. <td class="colFirst"><code>protected void</code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#handleIOException-java.io.IOException-">handleIOException</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;e)</code>
  219. <div class="block">Handle any IOExceptions thrown.</div>
  220. </td>
  221. </tr>
  222. <tr id="i5" class="rowColor">
  223. <td class="colFirst"><code>void</code></td>
  224. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-byte:A-">write</a></span>(byte[]&nbsp;bts)</code>
  225. <div class="block">Invokes the delegate's <code>write(byte[])</code> method.</div>
  226. </td>
  227. </tr>
  228. <tr id="i6" class="altColor">
  229. <td class="colFirst"><code>void</code></td>
  230. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-byte:A-int-int-">write</a></span>(byte[]&nbsp;bts,
  231. int&nbsp;st,
  232. int&nbsp;end)</code>
  233. <div class="block">Invokes the delegate's <code>write(byte[])</code> method.</div>
  234. </td>
  235. </tr>
  236. <tr id="i7" class="rowColor">
  237. <td class="colFirst"><code>void</code></td>
  238. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-int-">write</a></span>(int&nbsp;idx)</code>
  239. <div class="block">Invokes the delegate's <code>write(int)</code> method.</div>
  240. </td>
  241. </tr>
  242. </table>
  243. <ul class="blockList">
  244. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  245. <!-- -->
  246. </a>
  247. <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>
  248. <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>
  249. </ul>
  250. </li>
  251. </ul>
  252. </li>
  253. </ul>
  254. </div>
  255. <div class="details">
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  259. <ul class="blockList">
  260. <li class="blockList"><a name="constructor.detail">
  261. <!-- -->
  262. </a>
  263. <h3>Constructor Detail</h3>
  264. <a name="ProxyOutputStream-java.io.OutputStream-">
  265. <!-- -->
  266. </a>
  267. <ul class="blockListLast">
  268. <li class="blockList">
  269. <h4>ProxyOutputStream</h4>
  270. <pre>public&nbsp;ProxyOutputStream(<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>&nbsp;proxy)</pre>
  271. <div class="block">Constructs a new ProxyOutputStream.</div>
  272. <dl>
  273. <dt><span class="paramLabel">Parameters:</span></dt>
  274. <dd><code>proxy</code> - the OutputStream to delegate to</dd>
  275. </dl>
  276. </li>
  277. </ul>
  278. </li>
  279. </ul>
  280. <!-- ============ METHOD DETAIL ========== -->
  281. <ul class="blockList">
  282. <li class="blockList"><a name="method.detail">
  283. <!-- -->
  284. </a>
  285. <h3>Method Detail</h3>
  286. <a name="write-int-">
  287. <!-- -->
  288. </a>
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <h4>write</h4>
  292. <pre>public&nbsp;void&nbsp;write(int&nbsp;idx)
  293. 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>
  294. <div class="block">Invokes the delegate's <code>write(int)</code> method.</div>
  295. <dl>
  296. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  297. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.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/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></code></dd>
  298. <dt><span class="paramLabel">Parameters:</span></dt>
  299. <dd><code>idx</code> - the byte to write</dd>
  300. <dt><span class="throwsLabel">Throws:</span></dt>
  301. <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>
  302. </dl>
  303. </li>
  304. </ul>
  305. <a name="write-byte:A-">
  306. <!-- -->
  307. </a>
  308. <ul class="blockList">
  309. <li class="blockList">
  310. <h4>write</h4>
  311. <pre>public&nbsp;void&nbsp;write(byte[]&nbsp;bts)
  312. 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>
  313. <div class="block">Invokes the delegate's <code>write(byte[])</code> method.</div>
  314. <dl>
  315. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  316. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.html?is-external=true#write-byte:A-" 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/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></code></dd>
  317. <dt><span class="paramLabel">Parameters:</span></dt>
  318. <dd><code>bts</code> - the bytes to write</dd>
  319. <dt><span class="throwsLabel">Throws:</span></dt>
  320. <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>
  321. </dl>
  322. </li>
  323. </ul>
  324. <a name="write-byte:A-int-int-">
  325. <!-- -->
  326. </a>
  327. <ul class="blockList">
  328. <li class="blockList">
  329. <h4>write</h4>
  330. <pre>public&nbsp;void&nbsp;write(byte[]&nbsp;bts,
  331. int&nbsp;st,
  332. int&nbsp;end)
  333. 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>
  334. <div class="block">Invokes the delegate's <code>write(byte[])</code> method.</div>
  335. <dl>
  336. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  337. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.html?is-external=true#write-byte:A-int-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/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></code></dd>
  338. <dt><span class="paramLabel">Parameters:</span></dt>
  339. <dd><code>bts</code> - the bytes to write</dd>
  340. <dd><code>st</code> - The start offset</dd>
  341. <dd><code>end</code> - The number of bytes to write</dd>
  342. <dt><span class="throwsLabel">Throws:</span></dt>
  343. <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>
  344. </dl>
  345. </li>
  346. </ul>
  347. <a name="flush--">
  348. <!-- -->
  349. </a>
  350. <ul class="blockList">
  351. <li class="blockList">
  352. <h4>flush</h4>
  353. <pre>public&nbsp;void&nbsp;flush()
  354. 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>
  355. <div class="block">Invokes the delegate's <code>flush()</code> method.</div>
  356. <dl>
  357. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  358. <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>
  359. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  360. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.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/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></code></dd>
  361. <dt><span class="throwsLabel">Throws:</span></dt>
  362. <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>
  363. </dl>
  364. </li>
  365. </ul>
  366. <a name="close--">
  367. <!-- -->
  368. </a>
  369. <ul class="blockList">
  370. <li class="blockList">
  371. <h4>close</h4>
  372. <pre>public&nbsp;void&nbsp;close()
  373. 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>
  374. <div class="block">Invokes the delegate's <code>close()</code> method.</div>
  375. <dl>
  376. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  377. <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>
  378. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  379. <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>
  380. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  381. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterOutputStream.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/FilterOutputStream.html?is-external=true" title="class or interface in java.io">FilterOutputStream</a></code></dd>
  382. <dt><span class="throwsLabel">Throws:</span></dt>
  383. <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>
  384. </dl>
  385. </li>
  386. </ul>
  387. <a name="beforeWrite-int-">
  388. <!-- -->
  389. </a>
  390. <ul class="blockList">
  391. <li class="blockList">
  392. <h4>beforeWrite</h4>
  393. <pre>protected&nbsp;void&nbsp;beforeWrite(int&nbsp;n)
  394. 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>
  395. <div class="block">Invoked by the write methods before the call is proxied. The number
  396. of bytes to be written (1 for the <a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-int-"><code>write(int)</code></a> method, buffer
  397. length for <a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-byte:A-"><code>write(byte[])</code></a>, etc.) is given as an argument.
  398. <p>
  399. Subclasses can override this method to add common pre-processing
  400. functionality without having to override all the write methods.
  401. The default implementation does nothing.</div>
  402. <dl>
  403. <dt><span class="paramLabel">Parameters:</span></dt>
  404. <dd><code>n</code> - number of bytes to be written</dd>
  405. <dt><span class="throwsLabel">Throws:</span></dt>
  406. <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 the pre-processing fails</dd>
  407. <dt><span class="simpleTagLabel">Since:</span></dt>
  408. <dd>2.0</dd>
  409. </dl>
  410. </li>
  411. </ul>
  412. <a name="afterWrite-int-">
  413. <!-- -->
  414. </a>
  415. <ul class="blockList">
  416. <li class="blockList">
  417. <h4>afterWrite</h4>
  418. <pre>protected&nbsp;void&nbsp;afterWrite(int&nbsp;n)
  419. 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>
  420. <div class="block">Invoked by the write methods after the proxied call has returned
  421. successfully. The number of bytes written (1 for the
  422. <a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-int-"><code>write(int)</code></a> method, buffer length for <a href="../../../../../org/apache/commons/io/output/ProxyOutputStream.html#write-byte:A-"><code>write(byte[])</code></a>,
  423. etc.) is given as an argument.
  424. <p>
  425. Subclasses can override this method to add common post-processing
  426. functionality without having to override all the write methods.
  427. The default implementation does nothing.</div>
  428. <dl>
  429. <dt><span class="paramLabel">Parameters:</span></dt>
  430. <dd><code>n</code> - number of bytes written</dd>
  431. <dt><span class="throwsLabel">Throws:</span></dt>
  432. <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 the post-processing fails</dd>
  433. <dt><span class="simpleTagLabel">Since:</span></dt>
  434. <dd>2.0</dd>
  435. </dl>
  436. </li>
  437. </ul>
  438. <a name="handleIOException-java.io.IOException-">
  439. <!-- -->
  440. </a>
  441. <ul class="blockListLast">
  442. <li class="blockList">
  443. <h4>handleIOException</h4>
  444. <pre>protected&nbsp;void&nbsp;handleIOException(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>&nbsp;e)
  445. 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>
  446. <div class="block">Handle any IOExceptions thrown.
  447. <p>
  448. This method provides a point to implement custom exception
  449. handling. The default behaviour is to re-throw the exception.</div>
  450. <dl>
  451. <dt><span class="paramLabel">Parameters:</span></dt>
  452. <dd><code>e</code> - The IOException thrown</dd>
  453. <dt><span class="throwsLabel">Throws:</span></dt>
  454. <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>
  455. <dt><span class="simpleTagLabel">Since:</span></dt>
  456. <dd>2.0</dd>
  457. </dl>
  458. </li>
  459. </ul>
  460. </li>
  461. </ul>
  462. </li>
  463. </ul>
  464. </div>
  465. </div>
  466. <!-- ========= END OF CLASS DATA ========= -->
  467. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  468. <div class="bottomNav"><a name="navbar.bottom">
  469. <!-- -->
  470. </a>
  471. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  472. <a name="navbar.bottom.firstrow">
  473. <!-- -->
  474. </a>
  475. <ul class="navList" title="Navigation">
  476. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  477. <li><a href="package-summary.html">Package</a></li>
  478. <li class="navBarCell1Rev">Class</li>
  479. <li><a href="class-use/ProxyOutputStream.html">Use</a></li>
  480. <li><a href="package-tree.html">Tree</a></li>
  481. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  482. <li><a href="../../../../../index-all.html">Index</a></li>
  483. <li><a href="../../../../../help-doc.html">Help</a></li>
  484. </ul>
  485. </div>
  486. <div class="subNav">
  487. <ul class="navList">
  488. <li><a href="../../../../../org/apache/commons/io/output/NullWriter.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  489. <li><a href="../../../../../org/apache/commons/io/output/ProxyWriter.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  490. </ul>
  491. <ul class="navList">
  492. <li><a href="../../../../../index.html?org/apache/commons/io/output/ProxyOutputStream.html" target="_top">Frames</a></li>
  493. <li><a href="ProxyOutputStream.html" target="_top">No&nbsp;Frames</a></li>
  494. </ul>
  495. <ul class="navList" id="allclasses_navbar_bottom">
  496. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  497. </ul>
  498. <div>
  499. <script type="text/javascript"><!--
  500. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  501. if(window==top) {
  502. allClassesLink.style.display = "block";
  503. }
  504. else {
  505. allClassesLink.style.display = "none";
  506. }
  507. //-->
  508. </script>
  509. </div>
  510. <div>
  511. <ul class="subNavList">
  512. <li>Summary:&nbsp;</li>
  513. <li>Nested&nbsp;|&nbsp;</li>
  514. <li><a href="#fields.inherited.from.class.java.io.FilterOutputStream">Field</a>&nbsp;|&nbsp;</li>
  515. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  516. <li><a href="#method.summary">Method</a></li>
  517. </ul>
  518. <ul class="subNavList">
  519. <li>Detail:&nbsp;</li>
  520. <li>Field&nbsp;|&nbsp;</li>
  521. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  522. <li><a href="#method.detail">Method</a></li>
  523. </ul>
  524. </div>
  525. <a name="skip.navbar.bottom">
  526. <!-- -->
  527. </a></div>
  528. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  529. <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>
  530. </body>
  531. </html>