svn commit: r1204970 - /lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/FilterIndexReader.java

[us...@apache.org]

Author: uschindler
Date: Tue Nov 22 13:14:59 2011
New Revision: 1204970

URL: http://svn.apache.org/viewvc?rev=1204970&view=rev
Log:
LUCENE-3464: Add javadocs about reopening FilterIndexReader

Modified:
    lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/FilterIndexReader.java

Modified: lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/FilterIndexReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/FilterIndexReader.java?rev=1204970&r1=1204969&r2=1204970&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/FilterIndexReader.java (original)
+++ lucene/dev/branches/branch_3x/lucene/src/java/org/apache/lucene/index/FilterIndexReader.java Tue Nov 22 13:14:59 2011
@@ -35,6 +35,11 @@ import java.util.concurrent.ConcurrentHa
  * contained index reader. Subclasses of <code>FilterIndexReader</code> may
  * further override some of these methods and may also provide additional
  * methods and fields.
+ * <p><b>Note:</b> The default implementation of {@link FilterIndexReader#doOpenIfChanged}
+ * throws {@link UnsupportedOperationException} (like the base class),
+ * so it's not possible to reopen a <code>FilterIndexReader</code>.
+ * To reopen, you have to first reopen the underlying reader
+ * and wrap it again with the custom filter.
  */
 public class FilterIndexReader extends IndexReader {