HighlightingExcerptProvider (Apache Jackrabbit 2.23.1-beta API)

All Superinterfaces:

ExcerptProvider

All Known Implementing Classes:

AbstractExcerpt, DefaultHTMLExcerpt, DefaultXMLExcerpt, WeightedHTMLExcerpt, WeightedXMLExcerpt
```
public interface HighlightingExcerptProvider
extends ExcerptProvider
```
HighlightingExcerptProvider extends the ExcerptProvider interface with a method that highlights matching terms in arbitrary text.

- Field Summary
  - Fields inherited from interface org.apache.jackrabbit.core.query.lucene.ExcerptProvider
    REP_EXCERPT
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  String highlight(String text)
  Highlights the matching terms in the passed text.
  - Methods inherited from interface org.apache.jackrabbit.core.query.lucene.ExcerptProvider
    getExcerpt, init

- Method Detail
  - highlight
```
String highlight(String text)
          throws IOException
```
    Highlights the matching terms in the passed text.
    
    Parameters:
    
    text - the input text.
    
    Returns:
    
    the highlighted text.
    
    Throws:
    
    IOException - if an error occurs while highlighting the text.