lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mikemcc...@apache.org
Subject svn commit: r1364107 - /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java
Date Sat, 21 Jul 2012 14:39:36 GMT
Author: mikemccand
Date: Sat Jul 21 14:39:36 2012
New Revision: 1364107

URL: http://svn.apache.org/viewvc?rev=1364107&view=rev
Log:
explain that app should not change returned BytesRef payload

Modified:
    lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java?rev=1364107&r1=1364106&r2=1364107&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java
(original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocsAndPositionsEnum.java
Sat Jul 21 14:39:36 2012
@@ -42,7 +42,9 @@ public abstract class DocsAndPositionsEn
 
   /** 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();



Mime
View raw message