# Uses of Interface
org.apache.lucene.search.matchhighlight.MatchRegionRetriever.MatchOffsetsConsumer

Packages that use MatchRegionRetriever.MatchOffsetsConsumer
Package
Description
org.apache.lucene.search.matchhighlight
This package contains several components useful to build a highlighter on top of the `Matches` API.

## Uses of MatchRegionRetriever.MatchOffsetsConsumer in org.apache.lucene.search.matchhighlight

Methods in org.apache.lucene.search.matchhighlight with parameters of type MatchRegionRetriever.MatchOffsetsConsumer
Modifier and Type
Method
Description
`void`
MatchRegionRetriever.`highlightDocuments(PrimitiveIterator.OfInt docIds, MatchRegionRetriever.MatchOffsetsConsumer consumer, ToIntFunction<String> maxHitsPerField)`
Low-level, high-efficiency method for highlighting large numbers of documents at once.
`void`
MatchRegionRetriever.`highlightDocuments(PrimitiveIterator.OfInt docIds, MatchRegionRetriever.MatchOffsetsConsumer consumer, ToIntFunction<String> maxHitsPerField, int maxBlockSize, int maxBlocksProcessedInParallel)`
Low-level, high-efficiency method for highlighting large numbers of documents at once.
`void`
MatchRegionRetriever.`highlightDocuments(TopDocs topDocs, MatchRegionRetriever.MatchOffsetsConsumer consumer)`
Processes `TopDocs` with reasonable defaults.