org.apache.lucene.index

Class DocValuesFieldUpdates.Iterator

java.lang.Object

org.apache.lucene.index.DocValuesFieldUpdates.Iterator

Direct Known Subclasses:

BinaryDocValuesFieldUpdates.Iterator, NumericDocValuesFieldUpdates.Iterator

Enclosing class:

DocValuesFieldUpdates

abstract static class DocValuesFieldUpdates.Iterator
extends java.lang.Object

An iterator over documents and their updated values. Only documents with updates are returned by this iterator, and the documents are returned in increasing order.

Constructor Summary

Constructors

Constructor and Description
Iterator()

Method Summary

Modifier and Type	Method and Description
(package private) abstract int	doc() Returns the current document this iterator is on.
(package private) abstract int	nextDoc() Returns the next document which has an update, or DocIdSetIterator.NO_MORE_DOCS if there are no more documents to return.
(package private) abstract void	reset() Reset the iterator's state.
(package private) abstract java.lang.Object	value() Returns the value of the document returned from nextDoc().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Iterator

Iterator()

Method Detail

nextDoc

abstract int nextDoc()

Returns the next document which has an update, or DocIdSetIterator.NO_MORE_DOCS if there are no more documents to return.

doc

abstract int doc()

Returns the current document this iterator is on.

value

abstract java.lang.Object value()

Returns the value of the document returned from nextDoc(). A null value means that it was unset for this document.

reset

abstract void reset()

Reset the iterator's state. Should be called before nextDoc() and value().