lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r936829 - /lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/DocsEnum.java
Date Thu, 22 Apr 2010 13:16:29 GMT
Author: mikemccand
Date: Thu Apr 22 13:16:28 2010
New Revision: 936829

URL: http://svn.apache.org/viewvc?rev=936829&view=rev
Log:
improve flex javadocs

Modified:
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/DocsEnum.java

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/DocsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/DocsEnum.java?rev=936829&r1=936828&r2=936829&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/DocsEnum.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/index/DocsEnum.java Thu Apr 22 13:16:28
2010
@@ -60,16 +60,23 @@ public abstract class DocsEnum extends D
     }
   }
 
+  /** Call this once, up front, and hold a reference to the
+   *  returned bulk result.  When you call {@link #read}, it
+   *  fills the docs and freqs of this pre-shared bulk
+   *  result. */
   public BulkReadResult getBulkResult() {
     initBulkResult();
     return bulkResult;
   }
   
   /** Bulk read (docs and freqs).  After this is called,
-   * {@link #docID()} and {@link #freq} are undefined.  This
-   * returns the count read, or 0 if the end is reached.
-   * The IntsRef for docs and freqs will not have their
-   * length set.
+   *  {@link #docID()} and {@link #freq} are undefined.
+   *  This returns the count read, or 0 if the end is
+   *  reached.  The resulting docs and freqs are placed into
+   *  the pre-shard {@link BulkReadResult} instance returned
+   *  by {@link #getBulkResult}.  Note that the {@link
+   *  IntsRef} for docs and freqs will not have their length
+   *  set.
    * 
    *  <p>NOTE: the default impl simply delegates to {@link
    *  #nextDoc}, but subclasses may do this more



Mime
View raw message