diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java index bff55a00..11d1bba7 100644 --- a/src/main/java/org/apache/commons/csv/CSVParser.java +++ b/src/main/java/org/apache/commons/csv/CSVParser.java @@ -734,9 +734,24 @@ public final class CSVParser implements Iterable, Closeable { * {@link IllegalStateException}. *

*

- * If the parser is closed a call to {@link Iterator#next()} will throw a + * If the parser is closed, the iterator will not yield any more records. + * A call to {@link Iterator#hasNext()} will return {@code false} and + * a call to {@link Iterator#next()} will throw a * {@link NoSuchElementException}. *

+ *

+ * For example, the iterator from code such as + *

+     * Iterator{@code} items() throws IOException {
+     *    try (CSVParser parser = CSVParser.parse( ... )) {
+     *       return parser.iterator();
+     *    }
+     * }
+     * 
+ * will never yield any records because the parser is closed by the + * try-with-resources block. + * An alternative is to extract all records as a list with + * {@link getRecords()}, and return an iterator to that list. */ @Override public Iterator iterator() { @@ -799,7 +814,9 @@ public final class CSVParser implements Iterable, Closeable { /** * Returns a sequential {@code Stream} with this collection as its source. - * + *

+ * If the parser is closed, the stream will not produce any more values. + * See the comments in {@link iterator()}. * @return a sequential {@code Stream} with this collection as its source. * @since 1.9.0 */