Package com.atlassian.confluence.search.summary

Interface HitHighlighter

All Known Implementing Classes:
HitHighlighterImpl
public interface HitHighlighter
Finds search hits in content based on a given Lucene query. Highlights those hits with a formatter.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getSummary(String text)
    Get a summary, suitable for displaying excerpts of search results.
    String
    highlightText(String text)
    Highlights text without fragmenting it.

  • Method Details

    • getSummary

      String getSummary(String text)
      Get a summary, suitable for displaying excerpts of search results.
      Returns:
      a summary, or an empty string if the summary is null or empty.

    • highlightText

      String highlightText(String text)
      Highlights text without fragmenting it.