mirror of https://github.com/apache/lucene.git
improve flex javadocs
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@936829 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
e48349b757
commit
e5e05ae8ba
|
@ -60,16 +60,23 @@ public abstract class DocsEnum extends DocIdSetIterator {
|
|||
}
|
||||
}
|
||||
|
||||
/** 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
|
||||
|
|
Loading…
Reference in New Issue