mirror of https://github.com/apache/lucene.git
LUCENE-910: added or changed warning comments for APIs related to Payloads
git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@544713 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Busch
parent
db99e27deb
commit
35b5ace0ab
|
|
@ -39,12 +39,10 @@ import org.apache.lucene.index.TermPositions;
|
|||
{@link TermPositions#getPayload(byte[], int)} to retrieve the payloads from the index.
|
||||
|
||||
<br><br>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
@see org.apache.lucene.index.Payload
|
||||
*/
|
||||
|
|
@ -137,13 +135,10 @@ public class Token implements Cloneable {
|
|||
|
||||
/**
|
||||
* Sets this Token's payload.
|
||||
* <p>
|
||||
* <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>
|
||||
* <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>
|
||||
*/
|
||||
// TODO: Remove warning after API has been finalized
|
||||
public void setPayload(Payload payload) {
|
||||
|
|
@ -152,13 +147,10 @@ public class Token implements Cloneable {
|
|||
|
||||
/**
|
||||
* Returns this Token's payload.
|
||||
* <p>
|
||||
* <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>
|
||||
* <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>
|
||||
*/
|
||||
// TODO: Remove warning after API has been finalized
|
||||
public Payload getPayload() {
|
||||
|
|
|
|||
|
|
@ -34,12 +34,10 @@ import org.apache.lucene.analysis.TokenStream;
|
|||
* to retrieve the payloads from the index.<br>
|
||||
* <br>
|
||||
*
|
||||
* <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>
|
||||
* <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>
|
||||
*/
|
||||
// TODO: Remove warning after API has been finalized
|
||||
public class Payload implements Serializable {
|
||||
|
|
|
|||
|
|
@ -44,12 +44,10 @@ public interface TermPositions
|
|||
* This is invalid until {@link #nextPosition()} is called for
|
||||
* the first time.<br>
|
||||
* <br>
|
||||
* <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>
|
||||
* <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>
|
||||
* @return length of the current payload in number of bytes
|
||||
*/
|
||||
// TODO: Remove warning after API has been finalized
|
||||
|
|
@ -64,12 +62,10 @@ public interface TermPositions
|
|||
* so if the payload data for the current position is not needed,
|
||||
* this method may not be called at all for performance reasons.<br>
|
||||
* <br>
|
||||
* <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>
|
||||
* <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 data the array into which the data of this payload is to be
|
||||
* stored, if it is big enough; otherwise, a new byte[] array
|
||||
|
|
@ -88,14 +84,12 @@ public interface TermPositions
|
|||
* Payloads can only be loaded once per call to
|
||||
* {@link #nextPosition()}.
|
||||
*
|
||||
* @return true if there is a payload available at this position that can be loaded
|
||||
* <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>
|
||||
*
|
||||
* * <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>
|
||||
* @return true if there is a payload available at this position that can be loaded
|
||||
*/
|
||||
// TODO: Remove warning after API has been finalized
|
||||
public boolean isPayloadAvailable();
|
||||
|
|
|
|||
|
|
@ -37,6 +37,10 @@ import java.io.IOException;
|
|||
* <p>
|
||||
* Payload scores are averaged across term occurrences in the document.
|
||||
*
|
||||
* <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>
|
||||
*
|
||||
* @see org.apache.lucene.search.Similarity#scorePayload(byte[], int, int)
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -29,6 +29,13 @@
|
|||
<li><a href="./BoostingTermQuery.html">BoostingTermQuery</a> -- Boost a term's score based on the value of the payload located at that term</li>
|
||||
</ol>
|
||||
</div>
|
||||
<DIV>
|
||||
<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>
|
||||
</DIV>
|
||||
<DIV> </DIV>
|
||||
<DIV align="center">
|
||||
</DIV>
|
||||
|
|
|
|||
Loading…
Reference in New Issue