explain that app should not change returned BytesRef payload

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1364107 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2012-07-21 14:39:36 +00:00
parent 91150e2477
commit 832800b537
1 changed files with 3 additions and 1 deletions

View File

@ -42,7 +42,9 @@ public abstract class DocsAndPositionsEnum extends DocsEnum {
/** Returns the payload at this position, or null if no
* payload was indexed. Only call this once per
* position. */
* position. You should not modify anything (neither
* members of the returned BytesRef nor bytes in the
* byte[]). */
public abstract BytesRef getPayload() throws IOException;
public abstract boolean hasPayload();