# Uses of Interface
org.apache.lucene.search.matchhighlight.MatchHighlighter.FieldValueHighlighter

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

Methods in org.apache.lucene.search.matchhighlight that return MatchHighlighter.FieldValueHighlighter
Modifier and Type
Method
Description
`static MatchHighlighter.FieldValueHighlighter`
FieldValueHighlighters.`highlighted(int maxPassageWindow, int maxPassages, PassageFormatter passageFormatter, Predicate<String> matchFields)`
Highlights fields matching predicate `matchFields` only if they contained query matches.
`static MatchHighlighter.FieldValueHighlighter`
FieldValueHighlighters.`maxLeadingCharacters(int maxLeadingCharacters, String ellipsis, Set<String> fields)`
Displays up to `maxLeadingCharacters` of the field's value, regardless of whether it contained highlights or not.
`default MatchHighlighter.FieldValueHighlighter`
MatchHighlighter.FieldValueHighlighter.`or(MatchHighlighter.FieldValueHighlighter other)`
Returns a new field value highlighter that is a combination of this one and another one.
`static MatchHighlighter.FieldValueHighlighter`
FieldValueHighlighters.`skipRemaining()`
Matches all fields and omits their value in the output (so that no highlight or value is emitted).
`static MatchHighlighter.FieldValueHighlighter`
FieldValueHighlighters.`verbatimValue(String field, String... moreFields)`
Always returns raw field values, no highlighting or value truncation is applied.
Methods in org.apache.lucene.search.matchhighlight with parameters of type MatchHighlighter.FieldValueHighlighter
Modifier and Type
Method
Description
`MatchHighlighter`
MatchHighlighter.`appendFieldHighlighter(MatchHighlighter.FieldValueHighlighter highlighter)`
Append a new highlighter to field highlighters chain.
`default MatchHighlighter.FieldValueHighlighter`
MatchHighlighter.FieldValueHighlighter.`or(MatchHighlighter.FieldValueHighlighter other)`
Returns a new field value highlighter that is a combination of this one and another one.