BoundaryScanner (Lucene 10.5.1 highlighter API)
Description: declaration: package: org.apache.lucene.search.vectorhighlight, interface: BoundaryScanner

Package org.apache.lucene.search.vectorhighlight

# Interface BoundaryScanner

All Known Implementing Classes:
  `BreakIteratorBoundaryScanner`, `SimpleBoundaryScanner`

public interface BoundaryScanner
Finds fragment boundaries: pluggable into `BaseFragmentsBuilder`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `findEndOffset(StringBuilder buffer, int start)`
  Scan forward to find start offset.
  `int`
  `findStartOffset(StringBuilder buffer, int start)`
  Scan backward to find end offset.

- ## Method Details

  - ### findStartOffset

    int findStartOffset(StringBuilder buffer, int start)
    Scan backward to find end offset.
    Parameters:
      `buffer` - scanned object
      `start` - start offset to begin
    Returns:
      the found start offset

  - ### findEndOffset

    int findEndOffset(StringBuilder buffer, int start)
    Scan forward to find start offset.
    Parameters:
      `buffer` - scanned object
      `start` - start offset to begin
    Returns:
      the found end offset