Field Detail

• NO_MORE_DOCS

  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.

  See Also:

  Constant Field Values

Constructor Detail

• DocIdSetIterator

  public DocIdSetIterator()

Method Detail

• docID

  public abstract int docID()

  Returns the following:

  • -1 or NO_MORE_DOCS if nextDoc() or advance(int) were not called yet.
  • NO_MORE_DOCS if the iterator has exhausted.
  • Otherwise it should return the doc ID it is currently on.

  Since:

  2.9

• nextDoc

  public abstract int nextDoc()
                       throws IOException

  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

  Since:

  2.9

• advance

  public abstract int advance​(int target)
                       throws IOException

  Advances to the first beyond (see NOTE below) 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: when target ≤ current implementations may opt not to advance beyond their current docID().

  NOTE: this method may be called with 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

  Since:

  2.9