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

LUCENE-2887: sharpen jdocs for IndexReader.undeleteAll 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1063513 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2011-01-25 23:15:01 +00:00
parent bb391fd3ed
commit c403d3e756
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lucene/src/java/org/apache/lucene/index/IndexReader.java
View File

@ -1227,11 +1227,13 @@ public abstract class IndexReader implements Cloneable,Closeable {
/** Undeletes all documents currently marked as deleted in
* this index.
*
* <p>NOTE: this is only a best-effort process. For
* example, if all documents in a given segment were
* deleted, Lucene now drops that segment from the index,
* which means its documents will not be recovered by this
* method.
* <p>NOTE: this method can only recover documents marked
* for deletion but not yet removed from the index; when
* and how Lucene removes deleted documents is an
* implementation detail, subject to change from release
* to release. However, you can use {@link
* #numDeletedDocs} on the current IndexReader instance to
* see how many documents will be un-deleted.
*
* @throws StaleReaderException if the index has changed
* since this reader was opened