svn commit: r1523038 - in /cayenne/main/trunk: docs/doc/src/main/resources/UPGRADE.txt framework/cayenne-core-unpublished/src/main/java/org/apache/cayenne/ResultIterator.java

[aa...@apache.org]

Author: aadamchik
Date: Fri Sep 13 17:59:02 2013
New Revision: 1523038

URL: http://svn.apache.org/r1523038
Log:
CAY-1869 ResultIterator from cayenne-client dependency is subclassed from org.apache.cayenne.access.ResultIterator which is present only in cayenne-server dependency

upgrade notes
clarification in javadocs

Modified:
    cayenne/main/trunk/docs/doc/src/main/resources/UPGRADE.txt
    cayenne/main/trunk/framework/cayenne-core-unpublished/src/main/java/org/apache/cayenne/ResultIterator.java

Modified: cayenne/main/trunk/docs/doc/src/main/resources/UPGRADE.txt
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/doc/src/main/resources/UPGRADE.txt?rev=1523038&r1=1523037&r2=1523038&view=diff
==============================================================================
--- cayenne/main/trunk/docs/doc/src/main/resources/UPGRADE.txt (original)
+++ cayenne/main/trunk/docs/doc/src/main/resources/UPGRADE.txt Fri Sep 13 17:59:02 2013
@@ -25,7 +25,8 @@ UPGRADING TO 3.2M2
 
 * ResultIterator was moved to org.apache.cayenne to make it available on both server and client. When you upgrade
   related iterator code, make sure to check ResultIterator improvements (e.g. it implements Iterable, it is no 
-  longer limited to DataRows and can fetch objects just as easy). Also check ObjectContext.iterate(..) method.
+  longer limited to DataRows and can fetch objects just as easy, it no longer requires catching checked exceptions). 
+  Also check ObjectContext.iterate(..) method.
 
 UPGRADING TO 3.1B1
 

Modified: cayenne/main/trunk/framework/cayenne-core-unpublished/src/main/java/org/apache/cayenne/ResultIterator.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-core-unpublished/src/main/java/org/apache/cayenne/ResultIterator.java?rev=1523038&r1=1523037&r2=1523038&view=diff
==============================================================================
--- cayenne/main/trunk/framework/cayenne-core-unpublished/src/main/java/org/apache/cayenne/ResultIterator.java (original)
+++ cayenne/main/trunk/framework/cayenne-core-unpublished/src/main/java/org/apache/cayenne/ResultIterator.java Fri Sep 13 17:59:02 2013
@@ -24,12 +24,10 @@ import java.util.List;
 /**
  * Defines API of an iterator over the records returned as a result of
  * SelectQuery execution. Usually a ResultIterator is supported by an open
- * java.sql.ResultSet, therefore most of the methods would throw checked
- * exceptions. ResultIterators must be explicitly closed when the user is done
- * working with them.
- * <p>
- * Result "rows", depending on the query, may be represented as scalar values,
- * DataRows, or Object[] arrays containing a mix of scalars and DataRows.
+ * java.sql.ResultSet, therefore ResultIterators must be explicitly closed when
+ * the user is done working with them. An alternative to that is
+ * {@link ObjectContext#iterate(org.apache.cayenne.query.Select, ResultIteratorCallback)}
+ * method that handles resource management.
  */
 public interface ResultIterator<T> extends Iterable<T> {