public abstract class

DocIdSetIterator

extends Object
java.lang.Object
   ↳ org.apache.lucene.search.DocIdSetIterator
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore NO_MORE_DOCS is set to {@value #NO_MORE_DOCS} in order to be used as a sentinel object. Implementations of this class are expected to consider MAX_VALUE as an invalid value.

Summary

Constants
int NO_MORE_DOCS When returned by nextDoc(), advance(int) and docID() it means there are no more docs in the iterator.
Public Constructors
DocIdSetIterator()
Public Methods
abstract int advance(int target)
Advances to the first beyond the current whose document number is greater than or equal to target.
abstract int docID()
Returns the following:
abstract int nextDoc()
Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int NO_MORE_DOCS

When returned by nextDoc(), advance(int) and docID() it means there are no more docs in the iterator.

Constant Value: 2147483647 (0x7fffffff)

Public Constructors

public DocIdSetIterator ()

Public Methods

public abstract int advance (int target)

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set.

Behaves as if written: 

 int advance(int target) {
   int doc;
   while ((doc = nextDoc()) < target) {
   }
   return doc;
 }
Some implementations are considerably more efficient than that.

NOTE: certain implementations may return a different value (each time) if called several times in a row with the same target.

NOTE: this method may be called with {@value #NO_MORE_DOCS} for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Throws
IOException

public abstract int docID ()

Returns the following:

public abstract int nextDoc ()

Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Throws
IOException