svn commit: r1024214 - in /lucene/dev/branches/branch_3x/lucene: CHANGES.txt src/java/org/apache/lucene/index/IndexReader.java

[rm...@apache.org]

Author: rmuir
Date: Tue Oct 19 12:12:12 2010
New Revision: 1024214

URL: http://svn.apache.org/viewvc?rev=1024214&view=rev
Log:
LUCENE-2625: Add additional javadocs to IndexReader.termDocs() about seeking the enum before consuming

Modified:
    lucene/dev/branches/branch_3x/lucene/CHANGES.txt
    lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/IndexReader.java

Modified: lucene/dev/branches/branch_3x/lucene/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/CHANGES.txt?rev=1024214&r1=1024213&r2=1024214&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/CHANGES.txt (original)
+++ lucene/dev/branches/branch_3x/lucene/CHANGES.txt Tue Oct 19 12:12:12 2010
@@ -557,6 +557,10 @@ Documentation
   Java NOI behavior when a Thread is interrupted while blocking on IO.
   (Simon Willnauer, Robert Muir)
 
+* LUCENE-2625: Add a note to IndexReader.termDocs() with additional verbage
+  that the TermEnum must be seeked since it is unpositioned.
+  (Adriano Crestani via Robert Muir)
+  
 ================== Release 2.9.3 / 3.0.2 2010-06-18 ====================
 
 Changes in backwards compatibility policy

Modified: lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/IndexReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/IndexReader.java?rev=1024214&r1=1024213&r2=1024214&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/IndexReader.java (original)
+++ lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/IndexReader.java Tue Oct 19 12:12:12 2010
@@ -842,6 +842,11 @@ public abstract class IndexReader implem
   }
 
   /** Returns an unpositioned {@link TermDocs} enumerator.
+   * <p>
+   * Note: the TermDocs returned is unpositioned. Before using it, ensure
+   * that you first position it with {@link TermDocs#seek(Term)} or 
+   * {@link TermDocs#seek(TermEnum)}.
+   * 
    * @throws IOException if there is a low-level IO error
    */
   public abstract TermDocs termDocs() throws IOException;