UnixLineEndingInputStream.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  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>UnixLineEndingInputStream (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="UnixLineEndingInputStream (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":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/UnixLineEndingInputStream.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/TeeInputStream.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/WindowsLineEndingInputStream.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/UnixLineEndingInputStream.html" target="_top">Frames</a></li>
  57. <li><a href="UnixLineEndingInputStream.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io.input</div>
  96. <h2 title="Class UnixLineEndingInputStream" class="title">Class UnixLineEndingInputStream</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.UnixLineEndingInputStream</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">UnixLineEndingInputStream</span>
  122. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></pre>
  123. <div class="block">A filtering input stream that ensures the content will have unix-style line endings, LF.</div>
  124. <dl>
  125. <dt><span class="simpleTagLabel">Since:</span></dt>
  126. <dd>2.5</dd>
  127. </dl>
  128. </li>
  129. </ul>
  130. </div>
  131. <div class="summary">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  135. <ul class="blockList">
  136. <li class="blockList"><a name="constructor.summary">
  137. <!-- -->
  138. </a>
  139. <h3>Constructor Summary</h3>
  140. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  141. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  142. <tr>
  143. <th class="colOne" scope="col">Constructor and Description</th>
  144. </tr>
  145. <tr class="altColor">
  146. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/UnixLineEndingInputStream.html#UnixLineEndingInputStream-java.io.InputStream-boolean-">UnixLineEndingInputStream</a></span>(<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>&nbsp;in,
  147. boolean&nbsp;ensureLineFeedAtEndOfFile)</code>
  148. <div class="block">Create an input stream that filters another stream</div>
  149. </td>
  150. </tr>
  151. </table>
  152. </li>
  153. </ul>
  154. <!-- ========== METHOD SUMMARY =========== -->
  155. <ul class="blockList">
  156. <li class="blockList"><a name="method.summary">
  157. <!-- -->
  158. </a>
  159. <h3>Method Summary</h3>
  160. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  161. <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>
  162. <tr>
  163. <th class="colFirst" scope="col">Modifier and Type</th>
  164. <th class="colLast" scope="col">Method and Description</th>
  165. </tr>
  166. <tr id="i0" class="altColor">
  167. <td class="colFirst"><code>void</code></td>
  168. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/UnixLineEndingInputStream.html#close--">close</a></span>()</code>
  169. <div class="block">Closes the stream.</div>
  170. </td>
  171. </tr>
  172. <tr id="i1" class="rowColor">
  173. <td class="colFirst"><code>void</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/UnixLineEndingInputStream.html#mark-int-">mark</a></span>(int&nbsp;readlimit)</code></td>
  175. </tr>
  176. <tr id="i2" class="altColor">
  177. <td class="colFirst"><code>int</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/UnixLineEndingInputStream.html#read--">read</a></span>()</code></td>
  179. </tr>
  180. </table>
  181. <ul class="blockList">
  182. <li class="blockList"><a name="methods.inherited.from.class.java.io.InputStream">
  183. <!-- -->
  184. </a>
  185. <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>
  186. <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#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>
  187. </ul>
  188. <ul class="blockList">
  189. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  190. <!-- -->
  191. </a>
  192. <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>
  193. <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>
  194. </ul>
  195. </li>
  196. </ul>
  197. </li>
  198. </ul>
  199. </div>
  200. <div class="details">
  201. <ul class="blockList">
  202. <li class="blockList">
  203. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  204. <ul class="blockList">
  205. <li class="blockList"><a name="constructor.detail">
  206. <!-- -->
  207. </a>
  208. <h3>Constructor Detail</h3>
  209. <a name="UnixLineEndingInputStream-java.io.InputStream-boolean-">
  210. <!-- -->
  211. </a>
  212. <ul class="blockListLast">
  213. <li class="blockList">
  214. <h4>UnixLineEndingInputStream</h4>
  215. <pre>public&nbsp;UnixLineEndingInputStream(<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>&nbsp;in,
  216. boolean&nbsp;ensureLineFeedAtEndOfFile)</pre>
  217. <div class="block">Create an input stream that filters another stream</div>
  218. <dl>
  219. <dt><span class="paramLabel">Parameters:</span></dt>
  220. <dd><code>in</code> - The input stream to wrap</dd>
  221. <dd><code>ensureLineFeedAtEndOfFile</code> - true to ensure that the file ends with LF</dd>
  222. </dl>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. <!-- ============ METHOD DETAIL ========== -->
  228. <ul class="blockList">
  229. <li class="blockList"><a name="method.detail">
  230. <!-- -->
  231. </a>
  232. <h3>Method Detail</h3>
  233. <a name="read--">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>read</h4>
  239. <pre>public&nbsp;int&nbsp;read()
  240. 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>
  241. <dl>
  242. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  243. <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>
  244. <dt><span class="throwsLabel">Throws:</span></dt>
  245. <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></dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="close--">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>close</h4>
  255. <pre>public&nbsp;void&nbsp;close()
  256. 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>
  257. <div class="block">Closes the stream. Also closes the underlying stream.</div>
  258. <dl>
  259. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  260. <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>
  261. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  262. <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>
  263. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  264. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></dd>
  265. <dt><span class="throwsLabel">Throws:</span></dt>
  266. <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> - upon error</dd>
  267. </dl>
  268. </li>
  269. </ul>
  270. <a name="mark-int-">
  271. <!-- -->
  272. </a>
  273. <ul class="blockListLast">
  274. <li class="blockList">
  275. <h4>mark</h4>
  276. <pre>public&nbsp;void&nbsp;mark(int&nbsp;readlimit)</pre>
  277. <dl>
  278. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  279. <dd><code><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></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>
  280. </dl>
  281. </li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </li>
  286. </ul>
  287. </div>
  288. </div>
  289. <!-- ========= END OF CLASS DATA ========= -->
  290. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  291. <div class="bottomNav"><a name="navbar.bottom">
  292. <!-- -->
  293. </a>
  294. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  295. <a name="navbar.bottom.firstrow">
  296. <!-- -->
  297. </a>
  298. <ul class="navList" title="Navigation">
  299. <li><a href="../../../../../overview-summary.html">Overview</a></li>
  300. <li><a href="package-summary.html">Package</a></li>
  301. <li class="navBarCell1Rev">Class</li>
  302. <li><a href="class-use/UnixLineEndingInputStream.html">Use</a></li>
  303. <li><a href="package-tree.html">Tree</a></li>
  304. <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
  305. <li><a href="../../../../../index-all.html">Index</a></li>
  306. <li><a href="../../../../../help-doc.html">Help</a></li>
  307. </ul>
  308. </div>
  309. <div class="subNav">
  310. <ul class="navList">
  311. <li><a href="../../../../../org/apache/commons/io/input/TeeInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  312. <li><a href="../../../../../org/apache/commons/io/input/WindowsLineEndingInputStream.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  313. </ul>
  314. <ul class="navList">
  315. <li><a href="../../../../../index.html?org/apache/commons/io/input/UnixLineEndingInputStream.html" target="_top">Frames</a></li>
  316. <li><a href="UnixLineEndingInputStream.html" target="_top">No&nbsp;Frames</a></li>
  317. </ul>
  318. <ul class="navList" id="allclasses_navbar_bottom">
  319. <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  320. </ul>
  321. <div>
  322. <script type="text/javascript"><!--
  323. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  324. if(window==top) {
  325. allClassesLink.style.display = "block";
  326. }
  327. else {
  328. allClassesLink.style.display = "none";
  329. }
  330. //-->
  331. </script>
  332. </div>
  333. <div>
  334. <ul class="subNavList">
  335. <li>Summary:&nbsp;</li>
  336. <li>Nested&nbsp;|&nbsp;</li>
  337. <li>Field&nbsp;|&nbsp;</li>
  338. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  339. <li><a href="#method.summary">Method</a></li>
  340. </ul>
  341. <ul class="subNavList">
  342. <li>Detail:&nbsp;</li>
  343. <li>Field&nbsp;|&nbsp;</li>
  344. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  345. <li><a href="#method.detail">Method</a></li>
  346. </ul>
  347. </div>
  348. <a name="skip.navbar.bottom">
  349. <!-- -->
  350. </a></div>
  351. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  352. <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>
  353. </body>
  354. </html>