PayloadEncoder (Lucene 10.5.1 common API)
Description: declaration: package: org.apache.lucene.analysis.payloads, interface: PayloadEncoder

Package org.apache.lucene.analysis.payloads

# Interface PayloadEncoder

All Known Implementing Classes:
  `AbstractEncoder`, `FloatEncoder`, `IdentityEncoder`, `IntegerEncoder`

public interface PayloadEncoder
Mainly for use with the DelimitedPayloadTokenFilter, converts char buffers to `BytesRef`.

NOTE: This interface is subject to change

- ## Method Summary

  Modifier and Type
  Method
  Description
  `BytesRef`
  `encode(char[] buffer)`
  `BytesRef`
  `encode(char[] buffer, int offset, int length)`
  Convert a char array to a `BytesRef`

- ## Method Details

  - ### encode

    BytesRef encode(char[] buffer)

  - ### encode

    BytesRef encode(char[] buffer, int offset, int length)
    Convert a char array to a `BytesRef`
    Returns:
      encoded `BytesRef`