Added Javadoc remark about Iterable vs. Iterator

2012-08-18 19:07:08 +02:00 · 2012-08-18 19:07:08 +02:00 · 825d89d876
commit 825d89d876
parent 197c74931a
1 changed files with 3 additions and 0 deletions
--- a/jOOQ/src/main/java/org/jooq/Cursor.java
+++ b/jOOQ/src/main/java/org/jooq/Cursor.java
@ -52,6 +52,9 @@ import org.jooq.exception.MappingException;
 * <p>
 * Client code must close this {@link Cursor} in order to close the underlying
 * {@link PreparedStatement} and {@link ResultSet}
+ * <p>
+ * Note: Unlike usual implementations of {@link Iterable}, a <code>Cursor</code>
+ * can only provide one {@link Iterator}!
 *
 * @param <R> The cursor's record type
 * @author Lukas Eder