|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.io.LineIterator
public class LineIterator
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 close()
or 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); }
Constructor Summary | |
---|---|
LineIterator(Reader reader)
Constructs an iterator of the lines for a Reader . |
Method Summary | |
---|---|
void |
close()
Closes the underlying Reader quietly. |
static void |
closeQuietly(LineIterator iterator)
Closes the iterator, handling null and ignoring exceptions. |
boolean |
hasNext()
Indicates whether the Reader has more lines. |
protected boolean |
isValidLine(String line)
Overridable method to validate each line that is returned. |
Object |
next()
Returns the next line in the wrapped Reader . |
String |
nextLine()
Returns the next line in the wrapped Reader . |
void |
remove()
Unsupported. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LineIterator(Reader reader) throws IllegalArgumentException
Reader
.
reader
- the Reader
to read from, not null
IllegalArgumentException
- if the reader is nullMethod Detail |
---|
public boolean hasNext()
Reader
has more lines.
If there is an IOException
then close()
will
be called on this instance.
hasNext
in interface Iterator
true
if the Reader has more lines
IllegalStateException
- if an IO exception occursprotected boolean isValidLine(String line)
line
- the line that is to be validated
public Object next()
Reader
.
next
in interface Iterator
NoSuchElementException
- if there is no line to returnpublic String nextLine()
Reader
.
NoSuchElementException
- if there is no line to returnpublic void close()
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.
public void remove()
remove
in interface Iterator
UnsupportedOperationException
- alwayspublic static void closeQuietly(LineIterator iterator)
iterator
- the iterator to close
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |