svn commit: r555593 - /incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSIterator.java

[tw...@apache.org]

Author: twgoetz
Date: Thu Jul 12 04:42:47 2007
New Revision: 555593

URL: http://svn.apache.org/viewvc?view=rev&rev=555593
Log:
No Jira: add comment about not mixing Iterator and FSIterator method calls.

Modified:
    incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSIterator.java

Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSIterator.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSIterator.java?view=diff&rev=555593&r1=555592&r2=555593
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSIterator.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/FSIterator.java Thu Jul 12 04:42:47 2007
@@ -30,6 +30,11 @@
  * standard <code>hasNext</code> and <code>next</code> methods. If finer control, including
  * reverse iteration, is needed, see below.
  * 
+ * <p>Note: do not use the APIs described below *together* with the standard Java iterator methods
+ * <code>next()</code> and <code>hasNext()</code>.  On any given iterator, use either the one or the
+ * other, but not both together.  Otherwise, <code>next/hasNext</code> may exhibit incorrect
+ * behavior.
+ * 
  * <p>
  * The <code>FSIterator</code> interface introduces the methods {@link #get()},
  * {@link #moveToNext()}, {@link #moveToPrevious()} methods. With these methods, retrieving the