svn commit: r1458730 - in /lucene/dev/branches/branch_4x: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java

[mi...@apache.org]

Author: mikemccand
Date: Wed Mar 20 10:34:37 2013
New Revision: 1458730

URL: http://svn.apache.org/r1458730
Log:
add note about non-reentrant StoredFields impls

Modified:
    lucene/dev/branches/branch_4x/   (props changed)
    lucene/dev/branches/branch_4x/lucene/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java?rev=1458730&r1=1458729&r2=1458730&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java Wed Mar 20 10:34:37 2013
@@ -27,7 +27,13 @@ import org.apache.lucene.document.Docume
  * values in an index.  See {@link IndexReader#document(int,
  * StoredFieldVisitor)}.
  *
- * See {@link DocumentStoredFieldVisitor}, which is a
+ * <p><b>NOTE</b>: a {@code StoredFieldVisitor} implementation
+ * should not try to load or visit other stored documents in
+ * the same reader because the implementation of stored
+ * fields for most codecs is not reeentrant and you will see
+ * strange exceptions as a result.
+ *
+ * <p>See {@link DocumentStoredFieldVisitor}, which is a
  * <code>StoredFieldVisitor</code> that builds the
  * {@link Document} containing all stored fields.  This is
  * used by {@link IndexReader#document(int)}.