org.apache.lucene.search

Class HitIterator

java.lang.Object

org.apache.lucene.search.HitIterator

All Implemented Interfaces:

java.util.Iterator

public class HitIterator
extends java.lang.Object
implements java.util.Iterator

An iterator over Hits that provides lazy fetching of each document. Hits.iterator() returns an instance of this class. Calls to next() return a Hit instance.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
int	length() Returns the total number of hits.
java.lang.Object	next() Returns a Hit instance representing the next hit in Hits.
void	remove() Unsupported operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if current hit is less than the total number of Hits.

next

public java.lang.Object next()

Returns a Hit instance representing the next hit in Hits.

Specified by:

next in interface java.util.Iterator

Returns:

Next Hit.

remove

public void remove()

Unsupported operation.

Specified by:

remove in interface java.util.Iterator

Throws:

java.lang.UnsupportedOperationException

length

public int length()

Returns the total number of hits.