File	Doc	Category	Size	Date	Package
TermPositions.java	API Doc	Apache Lucene 2.2.0	3962	Sat Jun 16 22:20:36 BST 2007	org.apache.lucene.index

TermPositions

Fields Summary

Constructors Summary

Methods Summary
public byte[]	getPayload(byte[] data, int offset) Returns the payload data at the current term position. This is invalid until {@link #nextPosition()} is called for the first time. This method must not be called more than once after each call of {@link #nextPosition()}. However, 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. WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case. param data the array into which the data of this payload is to be stored, if it is big enough; otherwise, a new byte[] array is allocated for this purpose. param offset the offset in the array into which the data of this payload is to be stored. return a byte[] array containing the data of this payload throws IOException
public int	getPayloadLength() Returns the length of the payload at the current term position. This is invalid until {@link #nextPosition()} is called for the first time. WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case. return length of the current payload in number of bytes
public boolean	isPayloadAvailable() Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to {@link #nextPosition()}. WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case. return true if there is a payload available at this position that can be loaded
public int	nextPosition() Returns next position in the current document. It is an error to call this more than {@link #freq()} times without calling {@link #next()} This is invalid until {@link #next()} is called for the first time.