Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-910: Change of the Payload javadoc comment in Similarity.java 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@547995 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Busch 2007-06-16 23:25:34 +00:00
parent b265b576a9
commit 9578df3233
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/java/org/apache/lucene/search/Similarity.java
View File

@ -513,17 +513,16 @@ public abstract class Similarity implements Serializable {
* what is in the byte array.
* <p>
* The default implementation returns 1.
* <br>
* <p><font color="#FF0000">
* WARNING: The status of the <b>Payloads</b> feature is experimental.
* The APIs introduced here might change in the future and will not be
* supported anymore in such a case.</font>
*
* @param payload The payload byte array to be scored
* @param offset The offset into the payload array
* @param length The length in the array
* @return An implementation dependent float to be used as a scoring factor
* <b>
* 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. If you want to use this feature in a production environment
* you should wait for an official release.
* </b>
*/
// TODO: Remove warning after API has been finalized
public float scorePayload(byte [] payload, int offset, int length)