Method GetPayload
GetPayload()
Returns the payload data for the current span. this is invalid until Next() is called for the first time. This method must not be called more than once after each call of Next(). However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered SpanQuery does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.
Note that the return type is a collection, thus the ordering should not be relied upon.
@lucene.experimental
Declaration
public abstract ICollection<byte[]> GetPayload()Returns
| Type | Description |
|---|---|
| ICollection<System.Byte[]> | A ICollection{byte[]} of byte arrays containing the data of this payload,
otherwise |
