Skip to content

Commit 53851a4

Browse files
committed
Minor javadoc on Iterator behavior
1 parent f40db36 commit 53851a4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/main/java/com/fasterxml/sort/IteratingSorter.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ protected IteratingSorter(SortConfig config) {
4444
* using {@link DataReaderFactory} and {@link DataWriterFactory} configured
4545
* for this sorter.
4646
*
47+
* The returned Iterator will throw {@link IterableSorterException} if any
48+
* IOException is encountered during calls of {@link Iterator#next()}.
49+
*
4750
* @return Iterator if sorting complete and output is ready to be written; null if it was cancelled
4851
*/
4952
public Iterator<T> sort(DataReader<T> inputReader)

0 commit comments

Comments
 (0)