# Uses of Package
org.apache.lucene.search.matchhighlight

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

- Classes in org.apache.lucene.search.matchhighlight used by org.apache.lucene.search.matchhighlight
  Class | Description
  --- | ---
  MatchHighlighter | An example highlighter that combines several lower-level highlighting utilities in this package into a fully featured, ready-to-use component.
  MatchHighlighter.DocHighlights | Single document's highlights.
  MatchHighlighter.FieldValueHighlighter | Actual per-field highlighter.
  MatchHighlighter.QueryOffsetRange | An `OffsetRange` of a match, together with the source query that caused it.
  MatchRegionRetriever.FieldValueProvider | An abstraction that provides document values for a given field.
  MatchRegionRetriever.MatchOffsetsConsumer | A callback for accepting a single document (and its associated leaf reader, leaf document ID) and its match offset ranges, as indicated by the `Matches` interface retrieved for the query.
  OffsetRange | A non-empty range of offset positions.
  OffsetsFromPositions | This strategy applies to fields with stored positions but no offsets.
  OffsetsRetrievalStrategy | Determines how match offset regions are computed from `MatchesIterator`.
  OffsetsRetrievalStrategySupplier | A per-field supplier of `OffsetsRetrievalStrategy`.
  Passage | A passage is a fragment of source text, scored and possibly with a list of sub-offsets (markers) to be highlighted.
  PassageAdjuster | Adjusts the range of one or more passages over a given value.
  PassageFormatter | Formats a collection of passages over a given string, cleaning up and resolving restrictions concerning overlaps, allowed sub-ranges over the input string and length restrictions.
  PassageSelector | Selects fragments of text that score best for the given set of highlight markers.