A Payload is metadata that can be stored together with each occurrence of a term. This metadata is stored inline in the posting list of the specific term.

To store payloads in the index a {@link TokenStream} has to be used that produces payload data.

Use {@link TermPositions#GetPayloadLength()} and {@link TermPositions#GetPayload(byte[], int)} to retrieve the payloads from the index.

[SerializableAttribute]
public class Payload : ICloneable

<SerializableAttribute> _
Public Class Payload _
	Implements ICloneable

[SerializableAttribute]
public ref class Payload : ICloneable