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

[mi...@apache.org]

Author: mikemccand
Date: Wed Feb 11 11:14:47 2009
New Revision: 743303

URL: http://svn.apache.org/viewvc?rev=743303&view=rev
Log:
correct java code fragment in javadocs for reopen

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?rev=743303&r1=743302&r2=743303&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/IndexReader.java Wed Feb 11 11:14:47 2009
@@ -340,14 +340,18 @@
    * <pre>
    * IndexReader reader = ... 
    * ...
-   * IndexReader new = r.reopen();
-   * if (new != reader) {
-   *   ...     // reader was reopened
+   * IndexReader newReader = r.reopen();
+   * if (newReader != reader) {
+   * ...     // reader was reopened
    *   reader.close(); 
    * }
-   * reader = new;
+   * reader = newReader;
    * ...
    * </pre>
+   *
+   * Be sure to synchronize that code so that other threads,
+   * if present, can never use reader after it has been
+   * closed and before it's switched to newReader.
    * 
    * @throws CorruptIndexException if the index is corrupt
    * @throws IOException if there is a low-level IO error