LineIterator.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  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>LineIterator (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="LineIterator (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":41,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/LineIterator.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/IOUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/apache/commons/io/TaggedIOException.html" title="class in org.apache.commons.io"><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/LineIterator.html" target="_top">Frames</a></li>
  57. <li><a href="LineIterator.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</div>
  96. <h2 title="Class LineIterator" class="title">Class LineIterator</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>org.apache.commons.io.LineIterator</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <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>, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <span class="typeNameLabel">LineIterator</span>
  117. extends <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>
  118. implements <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;, <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></pre>
  119. <div class="block">An Iterator over the lines in a <code>Reader</code>.
  120. <p>
  121. <code>LineIterator</code> holds a reference to an open <code>Reader</code>.
  122. When you have finished with the iterator you should close the reader
  123. to free internal resources. This can be done by closing the reader directly,
  124. or by calling the <a href="../../../../org/apache/commons/io/LineIterator.html#close--"><code>close()</code></a> or <a href="../../../../org/apache/commons/io/LineIterator.html#closeQuietly-org.apache.commons.io.LineIterator-"><code>closeQuietly(LineIterator)</code></a>
  125. method on the iterator.
  126. <p>
  127. The recommended usage pattern is:
  128. <pre>
  129. LineIterator it = FileUtils.lineIterator(file, "UTF-8");
  130. try {
  131. while (it.hasNext()) {
  132. String line = it.nextLine();
  133. // do something with line
  134. }
  135. } finally {
  136. it.close();
  137. }
  138. </pre></div>
  139. <dl>
  140. <dt><span class="simpleTagLabel">Since:</span></dt>
  141. <dd>1.2</dd>
  142. </dl>
  143. </li>
  144. </ul>
  145. </div>
  146. <div class="summary">
  147. <ul class="blockList">
  148. <li class="blockList">
  149. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="constructor.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Constructor Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  156. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  157. <tr>
  158. <th class="colOne" scope="col">Constructor and Description</th>
  159. </tr>
  160. <tr class="altColor">
  161. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#LineIterator-java.io.Reader-">LineIterator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;reader)</code>
  162. <div class="block">Constructs an iterator of the lines for a <code>Reader</code>.</div>
  163. </td>
  164. </tr>
  165. </table>
  166. </li>
  167. </ul>
  168. <!-- ========== METHOD SUMMARY =========== -->
  169. <ul class="blockList">
  170. <li class="blockList"><a name="method.summary">
  171. <!-- -->
  172. </a>
  173. <h3>Method Summary</h3>
  174. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  175. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  176. <tr>
  177. <th class="colFirst" scope="col">Modifier and Type</th>
  178. <th class="colLast" scope="col">Method and Description</th>
  179. </tr>
  180. <tr id="i0" class="altColor">
  181. <td class="colFirst"><code>void</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#close--">close</a></span>()</code>
  183. <div class="block">Closes the underlying <code>Reader</code>.</div>
  184. </td>
  185. </tr>
  186. <tr id="i1" class="rowColor">
  187. <td class="colFirst"><code>static void</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#closeQuietly-org.apache.commons.io.LineIterator-">closeQuietly</a></span>(<a href="../../../../org/apache/commons/io/LineIterator.html" title="class in org.apache.commons.io">LineIterator</a>&nbsp;iterator)</code>
  189. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  190. <div class="block"><span class="deprecationComment">As of 2.6 removed without replacement. Please use the try-with-resources statement or handle
  191. suppressed exceptions manually.</span></div>
  192. </div>
  193. </td>
  194. </tr>
  195. <tr id="i2" class="altColor">
  196. <td class="colFirst"><code>boolean</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#hasNext--">hasNext</a></span>()</code>
  198. <div class="block">Indicates whether the <code>Reader</code> has more lines.</div>
  199. </td>
  200. </tr>
  201. <tr id="i3" class="rowColor">
  202. <td class="colFirst"><code>protected boolean</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#isValidLine-java.lang.String-">isValidLine</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;line)</code>
  204. <div class="block">Overridable method to validate each line that is returned.</div>
  205. </td>
  206. </tr>
  207. <tr id="i4" class="altColor">
  208. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  209. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#next--">next</a></span>()</code>
  210. <div class="block">Returns the next line in the wrapped <code>Reader</code>.</div>
  211. </td>
  212. </tr>
  213. <tr id="i5" class="rowColor">
  214. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  215. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#nextLine--">nextLine</a></span>()</code>
  216. <div class="block">Returns the next line in the wrapped <code>Reader</code>.</div>
  217. </td>
  218. </tr>
  219. <tr id="i6" class="altColor">
  220. <td class="colFirst"><code>void</code></td>
  221. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/LineIterator.html#remove--">remove</a></span>()</code>
  222. <div class="block">Unsupported.</div>
  223. </td>
  224. </tr>
  225. </table>
  226. <ul class="blockList">
  227. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  228. <!-- -->
  229. </a>
  230. <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>
  231. <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>
  232. </ul>
  233. <ul class="blockList">
  234. <li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator">
  235. <!-- -->
  236. </a>
  237. <h3>Methods inherited from interface&nbsp;java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></h3>
  238. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true#forEachRemaining-java.util.function.Consumer-" title="class or interface in java.util">forEachRemaining</a></code></li>
  239. </ul>
  240. </li>
  241. </ul>
  242. </li>
  243. </ul>
  244. </div>
  245. <div class="details">
  246. <ul class="blockList">
  247. <li class="blockList">
  248. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  249. <ul class="blockList">
  250. <li class="blockList"><a name="constructor.detail">
  251. <!-- -->
  252. </a>
  253. <h3>Constructor Detail</h3>
  254. <a name="LineIterator-java.io.Reader-">
  255. <!-- -->
  256. </a>
  257. <ul class="blockListLast">
  258. <li class="blockList">
  259. <h4>LineIterator</h4>
  260. <pre>public&nbsp;LineIterator(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;reader)
  261. throws <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></pre>
  262. <div class="block">Constructs an iterator of the lines for a <code>Reader</code>.</div>
  263. <dl>
  264. <dt><span class="paramLabel">Parameters:</span></dt>
  265. <dd><code>reader</code> - the <code>Reader</code> to read from, not null</dd>
  266. <dt><span class="throwsLabel">Throws:</span></dt>
  267. <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 reader is null</dd>
  268. </dl>
  269. </li>
  270. </ul>
  271. </li>
  272. </ul>
  273. <!-- ============ METHOD DETAIL ========== -->
  274. <ul class="blockList">
  275. <li class="blockList"><a name="method.detail">
  276. <!-- -->
  277. </a>
  278. <h3>Method Detail</h3>
  279. <a name="hasNext--">
  280. <!-- -->
  281. </a>
  282. <ul class="blockList">
  283. <li class="blockList">
  284. <h4>hasNext</h4>
  285. <pre>public&nbsp;boolean&nbsp;hasNext()</pre>
  286. <div class="block">Indicates whether the <code>Reader</code> has more lines.
  287. If there is an <code>IOException</code> then <a href="../../../../org/apache/commons/io/LineIterator.html#close--"><code>close()</code></a> will
  288. be called on this instance.</div>
  289. <dl>
  290. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  291. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true#hasNext--" title="class or interface in java.util">hasNext</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
  292. <dt><span class="returnLabel">Returns:</span></dt>
  293. <dd><code>true</code> if the Reader has more lines</dd>
  294. <dt><span class="throwsLabel">Throws:</span></dt>
  295. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if an IO exception occurs</dd>
  296. </dl>
  297. </li>
  298. </ul>
  299. <a name="isValidLine-java.lang.String-">
  300. <!-- -->
  301. </a>
  302. <ul class="blockList">
  303. <li class="blockList">
  304. <h4>isValidLine</h4>
  305. <pre>protected&nbsp;boolean&nbsp;isValidLine(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;line)</pre>
  306. <div class="block">Overridable method to validate each line that is returned.
  307. This implementation always returns true.</div>
  308. <dl>
  309. <dt><span class="paramLabel">Parameters:</span></dt>
  310. <dd><code>line</code> - the line that is to be validated</dd>
  311. <dt><span class="returnLabel">Returns:</span></dt>
  312. <dd>true if valid, false to remove from the iterator</dd>
  313. </dl>
  314. </li>
  315. </ul>
  316. <a name="next--">
  317. <!-- -->
  318. </a>
  319. <ul class="blockList">
  320. <li class="blockList">
  321. <h4>next</h4>
  322. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;next()</pre>
  323. <div class="block">Returns the next line in the wrapped <code>Reader</code>.</div>
  324. <dl>
  325. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  326. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true#next--" title="class or interface in java.util">next</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
  327. <dt><span class="returnLabel">Returns:</span></dt>
  328. <dd>the next line from the input</dd>
  329. <dt><span class="throwsLabel">Throws:</span></dt>
  330. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - if there is no line to return</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. <a name="nextLine--">
  335. <!-- -->
  336. </a>
  337. <ul class="blockList">
  338. <li class="blockList">
  339. <h4>nextLine</h4>
  340. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;nextLine()</pre>
  341. <div class="block">Returns the next line in the wrapped <code>Reader</code>.</div>
  342. <dl>
  343. <dt><span class="returnLabel">Returns:</span></dt>
  344. <dd>the next line from the input</dd>
  345. <dt><span class="throwsLabel">Throws:</span></dt>
  346. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - if there is no line to return</dd>
  347. </dl>
  348. </li>
  349. </ul>
  350. <a name="close--">
  351. <!-- -->
  352. </a>
  353. <ul class="blockList">
  354. <li class="blockList">
  355. <h4>close</h4>
  356. <pre>public&nbsp;void&nbsp;close()
  357. 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>
  358. <div class="block">Closes the underlying <code>Reader</code>.
  359. This method is useful if you only want to process the first few
  360. lines of a larger file. If you do not close the iterator
  361. then the <code>Reader</code> remains open.
  362. This method can safely be called multiple times.</div>
  363. <dl>
  364. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  365. <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>
  366. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  367. <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>
  368. <dt><span class="throwsLabel">Throws:</span></dt>
  369. <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 closing the underlying <code>Reader</code> fails.</dd>
  370. </dl>
  371. </li>
  372. </ul>
  373. <a name="remove--">
  374. <!-- -->
  375. </a>
  376. <ul class="blockList">
  377. <li class="blockList">
  378. <h4>remove</h4>
  379. <pre>public&nbsp;void&nbsp;remove()</pre>
  380. <div class="block">Unsupported.</div>
  381. <dl>
  382. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  383. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true#remove--" title="class or interface in java.util">remove</a></code>&nbsp;in interface&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></dd>
  384. <dt><span class="throwsLabel">Throws:</span></dt>
  385. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - always</dd>
  386. </dl>
  387. </li>
  388. </ul>
  389. <a name="closeQuietly-org.apache.commons.io.LineIterator-">
  390. <!-- -->
  391. </a>
  392. <ul class="blockListLast">
  393. <li class="blockList">
  394. <h4>closeQuietly</h4>
  395. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
  396. public static&nbsp;void&nbsp;closeQuietly(<a href="../../../../org/apache/commons/io/LineIterator.html" title="class in org.apache.commons.io">LineIterator</a>&nbsp;iterator)</pre>
  397. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 2.6 removed without replacement. Please use the try-with-resources statement or handle
  398. suppressed exceptions manually.</span></div>
  399. <div class="block">Closes a <code>LineIterator</code> quietly.</div>
  400. <dl>
  401. <dt><span class="paramLabel">Parameters:</span></dt>
  402. <dd><code>iterator</code> - The iterator to close, or <code>null</code>.</dd>
  403. <dt><span class="seeLabel">See Also:</span></dt>
  404. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang"><code>Throwable.addSuppressed(java.lang.Throwable)</code></a></dd>
  405. </dl>
  406. </li>
  407. </ul>
  408. </li>
  409. </ul>
  410. </li>
  411. </ul>
  412. </div>
  413. </div>
  414. <!-- ========= END OF CLASS DATA ========= -->
  415. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  416. <div class="bottomNav"><a name="navbar.bottom">
  417. <!-- -->
  418. </a>
  419. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  420. <a name="navbar.bottom.firstrow">
  421. <!-- -->
  422. </a>
  423. <ul class="navList" title="Navigation">
  424. <li><a href="../../../../overview-summary.html">Overview</a></li>
  425. <li><a href="package-summary.html">Package</a></li>
  426. <li class="navBarCell1Rev">Class</li>
  427. <li><a href="class-use/LineIterator.html">Use</a></li>
  428. <li><a href="package-tree.html">Tree</a></li>
  429. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  430. <li><a href="../../../../index-all.html">Index</a></li>
  431. <li><a href="../../../../help-doc.html">Help</a></li>
  432. </ul>
  433. </div>
  434. <div class="subNav">
  435. <ul class="navList">
  436. <li><a href="../../../../org/apache/commons/io/IOUtils.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  437. <li><a href="../../../../org/apache/commons/io/TaggedIOException.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  438. </ul>
  439. <ul class="navList">
  440. <li><a href="../../../../index.html?org/apache/commons/io/LineIterator.html" target="_top">Frames</a></li>
  441. <li><a href="LineIterator.html" target="_top">No&nbsp;Frames</a></li>
  442. </ul>
  443. <ul class="navList" id="allclasses_navbar_bottom">
  444. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  445. </ul>
  446. <div>
  447. <script type="text/javascript"><!--
  448. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  449. if(window==top) {
  450. allClassesLink.style.display = "block";
  451. }
  452. else {
  453. allClassesLink.style.display = "none";
  454. }
  455. //-->
  456. </script>
  457. </div>
  458. <div>
  459. <ul class="subNavList">
  460. <li>Summary:&nbsp;</li>
  461. <li>Nested&nbsp;|&nbsp;</li>
  462. <li>Field&nbsp;|&nbsp;</li>
  463. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  464. <li><a href="#method.summary">Method</a></li>
  465. </ul>
  466. <ul class="subNavList">
  467. <li>Detail:&nbsp;</li>
  468. <li>Field&nbsp;|&nbsp;</li>
  469. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  470. <li><a href="#method.detail">Method</a></li>
  471. </ul>
  472. </div>
  473. <a name="skip.navbar.bottom">
  474. <!-- -->
  475. </a></div>
  476. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  477. <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>
  478. </body>
  479. </html>