Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

javadoc: clarify when a reader may be closed 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@526546 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Naber 2007-04-08 12:40:33 +00:00
parent e21ffed782
commit 2412d83aa2
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/java/org/apache/lucene/document/Field.java
View File

@ -17,6 +17,7 @@ package org.apache.lucene.document;
* limitations under the License. * limitations under the License.
*/ */
import org.apache.lucene.index.IndexWriter; // for javadoc
import org.apache.lucene.util.Parameter; import org.apache.lucene.util.Parameter;
import java.io.Reader; import java.io.Reader;
@ -237,7 +238,9 @@ public final class Field extends AbstractField implements Fieldable, Serializabl
/** /**
* Create a tokenized and indexed field that is not stored. Term vectors will * 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 name The name of the field
* @param reader The reader with the content * @param reader The reader with the content
@ -249,7 +252,9 @@ public final class Field extends AbstractField implements Fieldable, Serializabl
/** /**
* Create a tokenized and indexed field that is not stored, optionally with * 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 name The name of the field
* @param reader The reader with the content * @param reader The reader with the content