PayloadAttribute (Lucene 9.11.1 core API)

All Superinterfaces:

Attribute

All Known Implementing Classes:

PayloadAttributeImpl
```
public interface PayloadAttribute
extends Attribute
```
The payload of a Token.
The payload is stored in the index at each position, and can be used to influence scoring when using Payload-based queries.
NOTE: because the payload will be stored at each position, it's usually best to use the minimum number of bytes necessary. Some codec implementations may optimize payload storage when all payloads have the same length.

See Also:

PostingsEnum

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`BytesRef`	`getPayload()`	Returns this Token's payload.
`void`	`setPayload(BytesRef payload)`	Sets this Token's payload.

- Method Detail
  - getPayload
```
BytesRef getPayload()
```
    Returns this Token's payload.
    
    See Also:
    
    setPayload(BytesRef)
  - setPayload
```
void setPayload(BytesRef payload)
```
    Sets this Token's payload.
    
    See Also:
    
    getPayload()