Field Detail

• buffer

  protected byte[] buffer

• payloadLength

  protected int payloadLength

Constructor Detail

• PayloadIterator

  public PayloadIterator​(IndexReader indexReader,
                         Term term)
                  throws IOException

  Throws:

  IOException

• PayloadIterator

  public PayloadIterator​(IndexReader indexReader,
                         Term term,
                         byte[] buffer)
                  throws IOException

  Throws:

  IOException

Method Detail

• init

  public boolean init()
               throws IOException

  (re)initialize the iterator. Should be done before the first call to setdoc(int). Returns false if there is no category list found (no setdoc() will never return true).

  Throws:

  IOException

• setdoc

  public boolean setdoc​(int docId)
                 throws IOException

  Skip forward to document docId. Return true if this document exists and has any payload.

  Users should call this method with increasing docIds, and implementations can assume that this is the case.

  Throws:

  IOException

• getBuffer

  public byte[] getBuffer()

  Get the buffer with the content of the last read payload.

• getPayloadLength

  public int getPayloadLength()

  Get the length of the last read payload.