From 1a35bbe0b34c20d3c6a3acf992bfda7c51c8a481 Mon Sep 17 00:00:00 2001
From: Michael McCandless <mikemccand@apache.org>
Date: Sat, 9 Jun 2007 14:31:08 +0000
Subject: [PATCH] LUCENE-924: small improvements to IndexWriter's javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@545751 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/lucene/index/IndexWriter.java  | 27 ++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/src/java/org/apache/lucene/index/IndexWriter.java b/src/java/org/apache/lucene/index/IndexWriter.java
index 3bb2ce70228..4934a5de653 100644
--- a/src/java/org/apache/lucene/index/IndexWriter.java
+++ b/src/java/org/apache/lucene/index/IndexWriter.java
@@ -252,7 +252,10 @@ public class IndexWriter {
   private boolean closed;
 
   /**
-   * @throws AlreadyClosedException if this IndexWriter is closed
+   * Used internally to throw an {@link
+   * AlreadyClosedException} if this IndexWriter has been
+   * closed.
+   * @throws AlreadyClosedException if this IndexWriter is
    */
   protected final void ensureOpen() throws AlreadyClosedException {
     if (closed) {
@@ -644,6 +647,8 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the largest number of documents allowed in a
+   * single segment.
    * @see #setMaxMergeDocs
    */
   public int getMaxMergeDocs() {
@@ -669,6 +674,8 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the maximum number of terms that will be
+   * indexed for a single field in a document.
    * @see #setMaxFieldLength
    */
   public int getMaxFieldLength() {
@@ -694,6 +701,8 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the number of buffered added documents that will
+   * trigger a flush.
    * @see #setMaxBufferedDocs
    */
   public int getMaxBufferedDocs() {
@@ -718,6 +727,8 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the number of buffered deleted terms that will
+   * trigger a flush.
    * @see #setMaxBufferedDeleteTerms
    */
   public int getMaxBufferedDeleteTerms() {
@@ -743,6 +754,9 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the number of segments that are merged at once
+   * and also controls the total number of segments allowed
+   * to accumulate in the index.
    * @see #setMergeFactor
    */
   public int getMergeFactor() {
@@ -759,6 +773,8 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the current default infoStream for newly
+   * instantiated IndexWriters.
    * @see #setDefaultInfoStream
    */
   public static PrintStream getDefaultInfoStream() {
@@ -776,6 +792,7 @@ public class IndexWriter {
   }
 
   /**
+   * Returns the current infoStream in use by this writer.
    * @see #setInfoStream
    */
   public PrintStream getInfoStream() {
@@ -793,6 +810,7 @@ public class IndexWriter {
   }
 
   /**
+   * Returns allowed timeout when acquiring the write lock.
    * @see #setWriteLockTimeout
    */
   public long getWriteLockTimeout() {
@@ -809,6 +827,8 @@ public class IndexWriter {
   }
 
   /**
+   * Returns default write lock timeout for newly
+   * instantiated IndexWriters.
    * @see #setDefaultWriteLockTimeout
    */
   public static long getDefaultWriteLockTimeout() {
@@ -1695,6 +1715,11 @@ public class IndexWriter {
     throws IOException {
   }
 
+  /**
+   * Used internally to trigger a flush if the number of
+   * buffered added documents or buffered deleted terms are
+   * large enough.
+   */
   protected final void maybeFlushRamSegments() throws CorruptIndexException, IOException {
     // A flush is triggered if enough new documents are buffered or
     // if enough delete terms are buffered