lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dna...@apache.org
Subject svn commit: r526546 - /lucene/java/trunk/src/java/org/apache/lucene/document/Field.java
Date Sun, 08 Apr 2007 12:40:34 GMT
Author: dnaber
Date: Sun Apr  8 05:40:33 2007
New Revision: 526546

URL: http://svn.apache.org/viewvc?view=rev&rev=526546
Log:
javadoc: clarify when a reader may be closed

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/document/Field.java

Modified: lucene/java/trunk/src/java/org/apache/lucene/document/Field.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/document/Field.java?view=diff&rev=526546&r1=526545&r2=526546
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/document/Field.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/document/Field.java Sun Apr  8 05:40:33 2007
@@ -17,6 +17,7 @@
  * limitations under the License.
  */
 
+import org.apache.lucene.index.IndexWriter;   // for javadoc
 import org.apache.lucene.util.Parameter;
 
 import java.io.Reader;
@@ -237,7 +238,9 @@
 
   /**
    * Create a tokenized and indexed field that is not stored. Term vectors will
-   * not be stored.  The Reader is read only when the Document is added to the index.
+   * not be stored.  The Reader is read only when the Document is added to the index,
+   * i.e. you may not close the Reader until {@link IndexWriter#addDocument(Document)}
+   * has been called.
    * 
    * @param name The name of the field
    * @param reader The reader with the content
@@ -249,7 +252,9 @@
 
   /**
    * Create a tokenized and indexed field that is not stored, optionally with 
-   * storing term vectors.  The Reader is read only when the Document is added to the index.
+   * storing term vectors.  The Reader is read only when the Document is added to the index,
+   * i.e. you may not close the Reader until {@link IndexWriter#addDocument(Document)}
+   * has been called.
    * 
    * @param name The name of the field
    * @param reader The reader with the content



Mime
View raw message