jdocs: note that calling close(false) can hit MergeAbortedExc's in optimize, addIndexes(IndexReader[]), expungeDeletes

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1063837 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2011-01-26 19:18:48 +00:00
parent 9e51a873f6
commit c40a12dd46
1 changed files with 18 additions and 2 deletions

View File

@ -1520,6 +1520,11 @@ public class IndexWriter implements Closeable {
* you should immediately close the writer. See <a * you should immediately close the writer. See <a
* href="#OOME">above</a> for details.</p> * href="#OOME">above</a> for details.</p>
* *
* <p><b>NOTE</b>: if you call {@link #close(boolean)}
* with <tt>false</tt>, which aborts all running merges,
* then any thread still running this method might hit a
* {@link MergePolicy.MergeAbortedException}.
*
* @throws CorruptIndexException if the index is corrupt * @throws CorruptIndexException if the index is corrupt
* @throws IOException if there is a low-level IO error * @throws IOException if there is a low-level IO error
* @see MergePolicy#findMergesForOptimize * @see MergePolicy#findMergesForOptimize
@ -1669,6 +1674,11 @@ public class IndexWriter implements Closeable {
* <p><b>NOTE</b>: if this method hits an OutOfMemoryError * <p><b>NOTE</b>: if this method hits an OutOfMemoryError
* you should immediately close the writer. See <a * you should immediately close the writer. See <a
* href="#OOME">above</a> for details.</p> * href="#OOME">above</a> for details.</p>
*
* <p><b>NOTE</b>: if you call {@link #close(boolean)}
* with <tt>false</tt>, which aborts all running merges,
* then any thread still running this method might hit a
* {@link MergePolicy.MergeAbortedException}.
*/ */
public void expungeDeletes(boolean doWait) public void expungeDeletes(boolean doWait)
throws CorruptIndexException, IOException { throws CorruptIndexException, IOException {
@ -1939,8 +1949,9 @@ public class IndexWriter implements Closeable {
* *
* <p>NOTE: this method will forcefully abort all merges * <p>NOTE: this method will forcefully abort all merges
* in progress. If other threads are running {@link * in progress. If other threads are running {@link
* #optimize()} or any of the addIndexes methods, they * #optimize()}, {@link #addIndexes(IndexReader[])} or
* will receive {@link MergePolicy.MergeAbortedException}s. * {@link #expungeDeletes} methods, they may receive
* {@link MergePolicy.MergeAbortedException}s.
*/ */
public synchronized void deleteAll() throws IOException { public synchronized void deleteAll() throws IOException {
try { try {
@ -2220,6 +2231,11 @@ public class IndexWriter implements Closeable {
* you should immediately close the writer. See <a * you should immediately close the writer. See <a
* href="#OOME">above</a> for details.</p> * href="#OOME">above</a> for details.</p>
* *
* <p><b>NOTE</b>: if you call {@link #close(boolean)}
* with <tt>false</tt>, which aborts all running merges,
* then any thread still running this method might hit a
* {@link MergePolicy.MergeAbortedException}.
*
* @throws CorruptIndexException if the index is corrupt * @throws CorruptIndexException if the index is corrupt
* @throws IOException if there is a low-level IO error * @throws IOException if there is a low-level IO error
*/ */