ChunkedOutputStream.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  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>ChunkedOutputStream (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="ChunkedOutputStream (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/ChunkedOutputStream.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/ByteArrayOutputStream.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/ChunkedWriter.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/ChunkedOutputStream.html" target="_top">Frames</a></li>
  57. <li><a href="ChunkedOutputStream.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 ChunkedOutputStream" class="title">Class ChunkedOutputStream</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.ChunkedOutputStream</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. <hr>
  125. <br>
  126. <pre>public class <span class="typeNameLabel">ChunkedOutputStream</span>
  127. 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>
  128. <div class="block">OutputStream which breaks larger output blocks into chunks.
  129. Native code may need to copy the input array; if the write buffer
  130. is very large this can cause OOME.</div>
  131. <dl>
  132. <dt><span class="simpleTagLabel">Since:</span></dt>
  133. <dd>2.5</dd>
  134. </dl>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="summary">
  139. <ul class="blockList">
  140. <li class="blockList">
  141. <!-- =========== FIELD SUMMARY =========== -->
  142. <ul class="blockList">
  143. <li class="blockList"><a name="field.summary">
  144. <!-- -->
  145. </a>
  146. <h3>Field Summary</h3>
  147. <ul class="blockList">
  148. <li class="blockList"><a name="fields.inherited.from.class.java.io.FilterOutputStream">
  149. <!-- -->
  150. </a>
  151. <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>
  152. <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>
  153. </ul>
  154. </li>
  155. </ul>
  156. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="constructor.summary">
  159. <!-- -->
  160. </a>
  161. <h3>Constructor Summary</h3>
  162. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  163. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  164. <tr>
  165. <th class="colOne" scope="col">Constructor and Description</th>
  166. </tr>
  167. <tr class="altColor">
  168. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ChunkedOutputStream.html#ChunkedOutputStream-java.io.OutputStream-">ChunkedOutputStream</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;stream)</code>
  169. <div class="block">Creates a new stream that uses a chunk size of <a href="../../../../../org/apache/commons/io/output/ChunkedOutputStream.html#DEFAULT_CHUNK_SIZE"><code>DEFAULT_CHUNK_SIZE</code></a>.</div>
  170. </td>
  171. </tr>
  172. <tr class="rowColor">
  173. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ChunkedOutputStream.html#ChunkedOutputStream-java.io.OutputStream-int-">ChunkedOutputStream</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;stream,
  174. int&nbsp;chunkSize)</code>
  175. <div class="block">Creates a new stream that uses the specified chunk size.</div>
  176. </td>
  177. </tr>
  178. </table>
  179. </li>
  180. </ul>
  181. <!-- ========== METHOD SUMMARY =========== -->
  182. <ul class="blockList">
  183. <li class="blockList"><a name="method.summary">
  184. <!-- -->
  185. </a>
  186. <h3>Method Summary</h3>
  187. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  188. <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>
  189. <tr>
  190. <th class="colFirst" scope="col">Modifier and Type</th>
  191. <th class="colLast" scope="col">Method and Description</th>
  192. </tr>
  193. <tr id="i0" class="altColor">
  194. <td class="colFirst"><code>void</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/output/ChunkedOutputStream.html#write-byte:A-int-int-">write</a></span>(byte[]&nbsp;data,
  196. int&nbsp;srcOffset,
  197. int&nbsp;length)</code>
  198. <div class="block">Writes the data buffer in chunks to the underlying stream</div>
  199. </td>
  200. </tr>
  201. </table>
  202. <ul class="blockList">
  203. <li class="blockList"><a name="methods.inherited.from.class.java.io.FilterOutputStream">
  204. <!-- -->
  205. </a>
  206. <h3>Methods 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>
  207. <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>, <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>, <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>, <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></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. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  225. <ul class="blockList">
  226. <li class="blockList"><a name="constructor.detail">
  227. <!-- -->
  228. </a>
  229. <h3>Constructor Detail</h3>
  230. <a name="ChunkedOutputStream-java.io.OutputStream-int-">
  231. <!-- -->
  232. </a>
  233. <ul class="blockList">
  234. <li class="blockList">
  235. <h4>ChunkedOutputStream</h4>
  236. <pre>public&nbsp;ChunkedOutputStream(<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;stream,
  237. int&nbsp;chunkSize)</pre>
  238. <div class="block">Creates a new stream that uses the specified chunk size.</div>
  239. <dl>
  240. <dt><span class="paramLabel">Parameters:</span></dt>
  241. <dd><code>stream</code> - the stream to wrap</dd>
  242. <dd><code>chunkSize</code> - the chunk size to use; must be a positive number.</dd>
  243. <dt><span class="throwsLabel">Throws:</span></dt>
  244. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the chunk size is &lt;= 0</dd>
  245. </dl>
  246. </li>
  247. </ul>
  248. <a name="ChunkedOutputStream-java.io.OutputStream-">
  249. <!-- -->
  250. </a>
  251. <ul class="blockListLast">
  252. <li class="blockList">
  253. <h4>ChunkedOutputStream</h4>
  254. <pre>public&nbsp;ChunkedOutputStream(<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;stream)</pre>
  255. <div class="block">Creates a new stream that uses a chunk size of <a href="../../../../../org/apache/commons/io/output/ChunkedOutputStream.html#DEFAULT_CHUNK_SIZE"><code>DEFAULT_CHUNK_SIZE</code></a>.</div>
  256. <dl>
  257. <dt><span class="paramLabel">Parameters:</span></dt>
  258. <dd><code>stream</code> - the stream to wrap</dd>
  259. </dl>
  260. </li>
  261. </ul>
  262. </li>
  263. </ul>
  264. <!-- ============ METHOD DETAIL ========== -->
  265. <ul class="blockList">
  266. <li class="blockList"><a name="method.detail">
  267. <!-- -->
  268. </a>
  269. <h3>Method Detail</h3>
  270. <a name="write-byte:A-int-int-">
  271. <!-- -->
  272. </a>
  273. <ul class="blockListLast">
  274. <li class="blockList">
  275. <h4>write</h4>
  276. <pre>public&nbsp;void&nbsp;write(byte[]&nbsp;data,
  277. int&nbsp;srcOffset,
  278. int&nbsp;length)
  279. 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>
  280. <div class="block">Writes the data buffer in chunks to the underlying stream</div>
  281. <dl>
  282. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  283. <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>
  284. <dt><span class="paramLabel">Parameters:</span></dt>
  285. <dd><code>data</code> - the data to write</dd>
  286. <dd><code>srcOffset</code> - the offset</dd>
  287. <dd><code>length</code> - the length of data to write</dd>
  288. <dt><span class="throwsLabel">Throws:</span></dt>
  289. <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>
  290. </dl>
  291. </li>
  292. </ul>
  293. </li>
  294. </ul>
  295. </li>
  296. </ul>
  297. </div>
  298. </div>
  299. <!-- ========= END OF CLASS DATA ========= -->
  300. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  301. <div class="bottomNav"><a name="navbar.bottom">
  302. <!-- -->
  303. </a>
  304. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  305. <a name="navbar.bottom.firstrow">
  306. <!-- -->
  307. </a>
  308. <ul class="navList" title="Navigation">
  309. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  310. <li><a href="package-summary.html">Package</a></li>
  311. <li class="navBarCell1Rev">Class</li>
  312. <li><a href="class-use/ChunkedOutputStream.html">Use</a></li>
  313. <li><a href="package-tree.html">Tree</a></li>
  314. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  315. <li><a href="../../../../../index-all.html">Index</a></li>
  316. <li><a href="../../../../../help-doc.html">Help</a></li>
  317. </ul>
  318. </div>
  319. <div class="subNav">
  320. <ul class="navList">
  321. <li><a href="../../../../../org/apache/commons/io/output/ByteArrayOutputStream.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  322. <li><a href="../../../../../org/apache/commons/io/output/ChunkedWriter.html" title="class in org.apache.commons.io.output"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  323. </ul>
  324. <ul class="navList">
  325. <li><a href="../../../../../index.html?org/apache/commons/io/output/ChunkedOutputStream.html" target="_top">Frames</a></li>
  326. <li><a href="ChunkedOutputStream.html" target="_top">No&nbsp;Frames</a></li>
  327. </ul>
  328. <ul class="navList" id="allclasses_navbar_bottom">
  329. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  330. </ul>
  331. <div>
  332. <script type="text/javascript"><!--
  333. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  334. if(window==top) {
  335. allClassesLink.style.display = "block";
  336. }
  337. else {
  338. allClassesLink.style.display = "none";
  339. }
  340. //-->
  341. </script>
  342. </div>
  343. <div>
  344. <ul class="subNavList">
  345. <li>Summary:&nbsp;</li>
  346. <li>Nested&nbsp;|&nbsp;</li>
  347. <li><a href="#fields.inherited.from.class.java.io.FilterOutputStream">Field</a>&nbsp;|&nbsp;</li>
  348. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  349. <li><a href="#method.summary">Method</a></li>
  350. </ul>
  351. <ul class="subNavList">
  352. <li>Detail:&nbsp;</li>
  353. <li>Field&nbsp;|&nbsp;</li>
  354. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  355. <li><a href="#method.detail">Method</a></li>
  356. </ul>
  357. </div>
  358. <a name="skip.navbar.bottom">
  359. <!-- -->
  360. </a></div>
  361. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  362. <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>
  363. </body>
  364. </html>