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

Package org.apache.lucene.search.uhighlight

# Interface LabelledCharArrayMatcher

All Superinterfaces:
  `CharArrayMatcher`

public interface LabelledCharArrayMatcher extends CharArrayMatcher
Associates a label with a CharArrayMatcher to distinguish different sources for terms in highlighting

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getLabel()`
  `static LabelledCharArrayMatcher`
  `wrap(String label, CharArrayMatcher in)`
  Associates a label with a CharArrayMatcher
  `static LabelledCharArrayMatcher`
  `wrap(String label, ByteRunAutomaton runAutomaton)`
  Returns a representation of the automaton that matches char[] instead of byte[]

  ### Methods inherited from interface org.apache.lucene.search.uhighlight.CharArrayMatcher

  `match, match`

- ## Method Details

  - ### getLabel

    String getLabel()
    Returns:
      the label for this matcher

  - ### wrap

    static LabelledCharArrayMatcher wrap(String label, CharArrayMatcher in)
    Associates a label with a CharArrayMatcher

  - ### wrap

    static LabelledCharArrayMatcher wrap(String label, ByteRunAutomaton runAutomaton)
    Returns a representation of the automaton that matches char[] instead of byte[]