Java Doc for LineIterator.java in  » Library » apache-common-IO » org » apache » commons » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » apache common IO » org.apache.commons.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.io.LineIterator

LineIterator
public class LineIterator implements Iterator(Code)
An Iterator over the lines in a Reader.

LineIterator holds a reference to an open Reader. When you have finished with the iterator you should close the reader to free internal resources. This can be done by closing the reader directly, or by calling the LineIterator.close() or LineIterator.closeQuietly(LineIterator) method on the iterator.

The recommended usage pattern is:

 LineIterator it = FileUtils.lineIterator(file, "UTF-8");
 try {
 while (it.hasNext()) {
 String line = it.nextLine();
 /// do something with line
 }
 } finally {
 LineIterator.closeQuietly(iterator);
 }
 

author:
   Niall Pemberton
author:
   Stephen Colebourne
author:
   Sandy McArthur
version:
   $Id: LineIterator.java 437567 2006-08-28 06:39:07Z bayard $
since:
   Commons IO 1.2



Constructor Summary
public  LineIterator(Reader reader)
     Constructs an iterator of the lines for a Reader.

Method Summary
public  voidclose()
     Closes the underlying Reader quietly. This method is useful if you only want to process the first few lines of a larger file.
public static  voidcloseQuietly(LineIterator iterator)
     Closes the iterator, handling null and ignoring exceptions.
public  booleanhasNext()
     Indicates whether the Reader has more lines.
protected  booleanisValidLine(String line)
     Overridable method to validate each line that is returned.
public  Objectnext()
     Returns the next line in the wrapped Reader.
public  StringnextLine()
     Returns the next line in the wrapped Reader.
public  voidremove()
     Unsupported.


Constructor Detail
LineIterator
public LineIterator(Reader reader) throws IllegalArgumentException(Code)
Constructs an iterator of the lines for a Reader.
Parameters:
  reader - the Reader to read from, not null
throws:
  IllegalArgumentException - if the reader is null




Method Detail
close
public void close()(Code)
Closes the underlying Reader quietly. This method is useful if you only want to process the first few lines of a larger file. If you do not close the iterator then the Reader remains open. This method can safely be called multiple times.



closeQuietly
public static void closeQuietly(LineIterator iterator)(Code)
Closes the iterator, handling null and ignoring exceptions.
Parameters:
  iterator - the iterator to close



hasNext
public boolean hasNext()(Code)
Indicates whether the Reader has more lines. If there is an IOException then LineIterator.close() will be called on this instance. true if the Reader has more lines
throws:
  IllegalStateException - if an IO exception occurs



isValidLine
protected boolean isValidLine(String line)(Code)
Overridable method to validate each line that is returned.
Parameters:
  line - the line that is to be validated true if valid, false to remove from the iterator



next
public Object next()(Code)
Returns the next line in the wrapped Reader. the next line from the input
throws:
  NoSuchElementException - if there is no line to return



nextLine
public String nextLine()(Code)
Returns the next line in the wrapped Reader. the next line from the input
throws:
  NoSuchElementException - if there is no line to return



remove
public void remove()(Code)
Unsupported.
throws:
  UnsupportedOperationException - always



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.