PayloadMatcher (Lucene 10.5.1 queries API)
Description: declaration: package: org.apache.lucene.queries.payloads, interface: PayloadMatcher

Package org.apache.lucene.queries.payloads

# Interface PayloadMatcher

public interface PayloadMatcher
Defines an interface for testing if two payloads should be consider to match

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `comparePayload(BytesRef source, BytesRef payload)`
  This method tests if two BytesRef match.

- ## Method Details

  - ### comparePayload

    boolean comparePayload(BytesRef source, BytesRef payload)
    This method tests if two BytesRef match.
    Parameters:
      `source` - left side of the compare
      `payload` - right side of the compare
    Returns:
      true if the BytesRefs are matching, otherwise false.