You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ojb-dev@db.apache.org by ar...@apache.org on 2004/05/05 15:06:03 UTC
cvs commit: db-ojb/src/java/org/apache/ojb/broker/accesslayer OJBIterator.java
arminw 2004/05/05 06:06:03
Modified: src/java/org/apache/ojb/broker/accesslayer OJBIterator.java
Log:
add javadoc
Revision Changes Path
1.9 +19 -5 db-ojb/src/java/org/apache/ojb/broker/accesslayer/OJBIterator.java
Index: OJBIterator.java
===================================================================
RCS file: /home/cvs/db-ojb/src/java/org/apache/ojb/broker/accesslayer/OJBIterator.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- OJBIterator.java 4 Apr 2004 23:53:31 -0000 1.8
+++ OJBIterator.java 5 May 2004 13:06:03 -0000 1.9
@@ -20,6 +20,20 @@
import org.apache.ojb.broker.PersistenceBrokerException;
/**
+ * A {@link Iterator} extension internaly used by OJB to handle query results.
+ *
+ * <p>
+ * NOTE: OJB is very strict in handling <tt>OJBIterator</tt> instances. <tt>OJBIterator</tt> is
+ * bound very closely to the used {@link org.apache.ojb.broker.PersistenceBroker} instance.
+ * Thus if you do a
+ * <br/> - {@link org.apache.ojb.broker.PersistenceBroker#close}
+ * <br/> - {@link org.apache.ojb.broker.PersistenceBroker#commitTransaction}
+ * <br/> - {@link org.apache.ojb.broker.PersistenceBroker#abortTransaction}
+ * <br/>
+ * call, the current <tt>OJBIterator</tt> instance resources will be cleaned up automatic
+ * and invalidate current instance.
+ * </p>
+ *
* @version $Id$
*/
public interface OJBIterator extends Iterator
@@ -30,11 +44,11 @@
int size() throws PersistenceBrokerException;
/**
- * @return the unlimited size of the iterator,
+ * @return the unlimited size of the iterator,
* fullSize() may differ from size() for PagingIterator
*/
int fullSize() throws PersistenceBrokerException;
-
+
/**
* Moves the cursor to the given row number in the iterator.
* If the row number is positive, the cursor moves to the given row number with
@@ -42,7 +56,7 @@
* @param row the row to move to in this iterator, by absolute number
*/
boolean absolute(int row) throws PersistenceBrokerException;
-
+
/**
* Moves the cursor a relative number of rows, either positive or negative. Attempting to move beyond the first/last
* row in the iterator positions the cursor before/after the the first/last row. Calling relative(0) is valid,
@@ -50,7 +64,7 @@
* @param row the row to move to in this iterator, by relative number
*/
boolean relative(int row) throws PersistenceBrokerException;
-
+
/**
* Release all internally used Database resources of the iterator.
* Clients must call this methods explicitely if the iterator is not
---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org