Package org.apache.lucene.search
Class DocIdStream
java.lang.Object
org.apache.lucene.search.DocIdStream
A stream of doc IDs. Doc IDs may be consumed at most once.
- See Also:
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Sole constructor, for invocation by sub classes. -
Method Summary
Modifier and TypeMethodDescriptionint
count()
Count the number of entries in this stream.abstract int
count
(int upTo) Count the number of doc IDs in this stream that are below the givenupTo
.abstract void
forEach
(int upTo, CheckedIntConsumer<IOException> consumer) Iterate over doc IDs contained in this doc ID stream up to the givenupTo
exclusive, calling the givenCheckedIntConsumer
on them.void
forEach
(CheckedIntConsumer<IOException> consumer) Iterate over doc IDs contained in this stream in order, calling the givenCheckedIntConsumer
on them.abstract boolean
Returntrue
if this stream may have remaining doc IDs.
-
Constructor Details
-
DocIdStream
protected DocIdStream()Sole constructor, for invocation by sub classes.
-
-
Method Details
-
forEach
Iterate over doc IDs contained in this stream in order, calling the givenCheckedIntConsumer
on them. This is a terminal operation.- Throws:
IOException
-
forEach
Iterate over doc IDs contained in this doc ID stream up to the givenupTo
exclusive, calling the givenCheckedIntConsumer
on them. It is not possible to iterate these doc IDs again later on.- Throws:
IOException
-
count
Count the number of entries in this stream. This is a terminal operation.- Throws:
IOException
-
count
Count the number of doc IDs in this stream that are below the givenupTo
. These doc IDs may not be consumed again later.- Throws:
IOException
-
mayHaveRemaining
public abstract boolean mayHaveRemaining()Returntrue
if this stream may have remaining doc IDs. This must eventually returnfalse
when the stream is exhausted.
-