+ 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. @see org.apache.lucene.index.Payload */ @@ -137,13 +135,10 @@ /** * Sets this Token's payload. - *
- * - * 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. - * + *
+ * 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. */ // TODO: Remove warning after API has been finalized public void setPayload(Payload payload) { @@ -152,13 +147,10 @@ /** * Returns this Token's payload. - *
- * - * 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. - * + *
+ * 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.
*/
// TODO: Remove warning after API has been finalized
public Payload getPayload() {
Index: src/java/org/apache/lucene/index/Payload.java
===================================================================
--- src/java/org/apache/lucene/index/Payload.java (revision 544711)
+++ src/java/org/apache/lucene/index/Payload.java (working copy)
@@ -34,12 +34,10 @@
* to retrieve the payloads from the index.
*
*
- *
- * 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.
- *
+ *
+ * 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.
*/
// TODO: Remove warning after API has been finalized
public class Payload implements Serializable {
Index: src/java/org/apache/lucene/index/TermPositions.java
===================================================================
--- src/java/org/apache/lucene/index/TermPositions.java (revision 544711)
+++ src/java/org/apache/lucene/index/TermPositions.java (working copy)
@@ -44,12 +44,10 @@
* 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. If you want to use this feature in a production environment
- * you should wait for an official release.
- *
+ *
+ * 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
*/
// TODO: Remove warning after API has been finalized
@@ -64,12 +62,10 @@
* 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. If you want to use this feature in a production environment
- * you should wait for an official release.
- *
+ *
+ * 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 @@ -88,14 +84,12 @@ * 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 - * - * * - * 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. - * */ // TODO: Remove warning after API has been finalized public boolean isPayloadAvailable(); Index: src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java =================================================================== --- src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java (revision 544711) +++ src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java (working copy) @@ -37,6 +37,10 @@ *
* Payload scores are averaged across term occurrences in the document. * + *
+ * 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. * * @see org.apache.lucene.search.Similarity#scorePayload(byte[], int, int) */ Index: src/java/org/apache/lucene/search/payloads/package.html =================================================================== --- src/java/org/apache/lucene/search/payloads/package.html (revision 544711) +++ src/java/org/apache/lucene/search/payloads/package.html (working copy) @@ -29,6 +29,13 @@