Author: scolebourne
Date: Sat Mar 4 13:38:10 2006
New Revision: 383206
URL: http://svn.apache.org/viewcvs?rev=383206&view=rev
Log:
Fix javadoc and method return type
Modified:
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Modified:
jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java?rev=383206&r1=383205&r2=383206&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
(original)
+++ jakarta/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Sat Mar 4 13:38:10 2006
@@ -509,19 +509,25 @@
//-----------------------------------------------------------------------
/**
* Return an Iterator for the lines in a <code>Reader</code>.
+ * Please read the javadoc of [EMAIL PROTECTED] LineIterator} to understand
+ * whether you should close the iterator.
+ * The file is closed if an exception is thrown.
*
* @param reader the <code>Reader</code> to read from, not null
* @return an Iterator of the lines in the reader, never null
* @throws NullPointerException if the reader is null
* @since Commons IO 1.2
*/
- public static Iterator lineIterator(Reader reader) {
+ public static LineIterator lineIterator(Reader reader) {
return new LineIterator(reader);
}
/**
* Return an Iterator for the lines in an <code>InputStream</code>, using
* the character encoding specified (or default encoding if null).
+ * Please read the javadoc of [EMAIL PROTECTED] LineIterator} to understand
+ * whether you should close the iterator.
+ * The file is closed if an exception is thrown.
*
* @param input the <code>InputStream</code> to read from, not null
* @param encoding the encoding to use, null means platform default
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
