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

Packages that use MatchRegionRetriever.FieldValueProvider
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.FieldValueProvider in org.apache.lucene.search.matchhighlight

Methods in org.apache.lucene.search.matchhighlight with parameters of type MatchRegionRetriever.FieldValueProvider
Modifier and Type
Method
Description
`void`
MatchRegionRetriever.MatchOffsetsConsumer.`accept(int docId, LeafReader leafReader, int leafDocId, MatchRegionRetriever.FieldValueProvider fieldValueProvider, Map<String,List<OffsetRange>> hits)`
`List<OffsetRange>`
OffsetsFromMatchIterator.`get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)`
`List<OffsetRange>`
OffsetsFromPositions.`get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)`
`List<OffsetRange>`
OffsetsFromTokens.`get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)`
`List<OffsetRange>`
OffsetsFromValues.`get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)`
`List<OffsetRange>`
OffsetsRetrievalStrategy.`get(MatchesIterator matchesIterator, MatchRegionRetriever.FieldValueProvider doc)`
Return value offsets (match ranges) acquired from the given `MatchesIterator`.
`void`
MatchRegionRetriever.`highlightDocument(LeafReaderContext leafReaderContext, int contextDocId, MatchRegionRetriever.FieldValueProvider doc, ToIntFunction<String> maxHitsPerField, Map<String,List<OffsetRange>> outputHighlights)`
Low-level method for retrieving hit ranges for a single document.