PayloadSpanCollector (Lucene 10.5.0 sandbox API)
Description: declaration: package: org.apache.lucene.payloads, class: PayloadSpanCollector

Package org.apache.lucene.payloads

# Class PayloadSpanCollector

java.lang.Object
org.apache.lucene.payloads.PayloadSpanCollector

All Implemented Interfaces:
  `SpanCollector`

public class PayloadSpanCollector extends Object implements SpanCollector
SpanCollector for collecting payloads

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `PayloadSpanCollector()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `collectLeaf(PostingsEnum postings, int position, Term term)`
  `Collection<byte[]>`
  `getPayloads()`
  `void`
  `reset()`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### PayloadSpanCollector

    public PayloadSpanCollector()

- ## Method Details

  - ### collectLeaf

    public void collectLeaf(PostingsEnum postings, int position, Term term) throws IOException
    Specified by:
      `collectLeaf` in interface `SpanCollector`
    Throws:
      `IOException`

  - ### reset

    public void reset()
    Specified by:
      `reset` in interface `SpanCollector`

  - ### getPayloads

    public Collection<byte[]> getPayloads()
    Returns:
      the collected payloads