svn commit: r542492 - /lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java

[mi...@apache.org]

Author: mikemccand
Date: Tue May 29 04:26:09 2007
New Revision: 542492

URL: http://svn.apache.org/viewvc?view=rev&rev=542492
Log:
javadoc improvement: clarify impact of IndexWriter's autoCommit flag on IndexReader's isCurrent method

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java?view=diff&rev=542492&r1=542491&r2=542492
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java Tue May 29 04:26:09 2007
@@ -322,9 +322,15 @@
   }
 
   /**
-   * Check whether this IndexReader still works on a current version of the index.
-   * If this is not the case you will need to re-open the IndexReader to
-   * make sure you see the latest changes made to the index.
+   * Check whether this IndexReader is still using the
+   * current (i.e., most recently committed) version of the
+   * index.  If a writer has committed any changes to the
+   * index since this reader was opened, this will return
+   * <code>false</code>, in which case you must open a new
+   * IndexReader in order to see the changes.  See the
+   * description of the <a href="IndexWriter.html#autoCommit"><code>autoCommit</code></a>
+   * flag which controls when the {@link IndexWriter}
+   * actually commits changes to the index.
    * 
    * @throws CorruptIndexException if the index is corrupt
    * @throws IOException if there is a low-level IO error