lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From busc...@apache.org
Subject svn commit: r544713 - in /lucene/java/trunk/src/java/org/apache/lucene: analysis/Token.java index/Payload.java index/TermPositions.java search/payloads/BoostingTermQuery.java search/payloads/package.html
Date Wed, 06 Jun 2007 02:57:05 GMT
Author: buschmi
Date: Tue Jun  5 19:57:03 2007
New Revision: 544713

URL: http://svn.apache.org/viewvc?view=rev&rev=544713
Log:
LUCENE-910: added or changed warning comments for APIs related to Payloads

Modified:
    lucene/java/trunk/src/java/org/apache/lucene/analysis/Token.java
    lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java
    lucene/java/trunk/src/java/org/apache/lucene/index/TermPositions.java
    lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java
    lucene/java/trunk/src/java/org/apache/lucene/search/payloads/package.html

Modified: lucene/java/trunk/src/java/org/apache/lucene/analysis/Token.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/analysis/Token.java?view=diff&rev=544713&r1=544712&r2=544713
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/analysis/Token.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/analysis/Token.java Tue Jun  5 19:57:03 2007
@@ -39,12 +39,10 @@
   {@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 @@
 
   /** 
    * 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 @@
   
   /** 
    * 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() {

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java?view=diff&rev=544713&r1=544712&r2=544713
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/Payload.java Tue Jun  5 19:57:03 2007
@@ -34,12 +34,10 @@
   *  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 {

Modified: lucene/java/trunk/src/java/org/apache/lucene/index/TermPositions.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/index/TermPositions.java?view=diff&rev=544713&r1=544712&r2=544713
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/index/TermPositions.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/index/TermPositions.java Tue Jun  5 19:57:03
2007
@@ -44,12 +44,10 @@
      * 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 @@
      * 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 @@
    * Payloads can only be loaded once per call to 
    * {@link #nextPosition()}.
    * 
+   * <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 true if there is a payload available at this position that can be loaded
-   *
-   * * <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 boolean isPayloadAvailable();

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java?view=diff&rev=544713&r1=544712&r2=544713
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/payloads/BoostingTermQuery.java Tue
Jun  5 19:57:03 2007
@@ -37,6 +37,10 @@
  * <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)
  */

Modified: lucene/java/trunk/src/java/org/apache/lucene/search/payloads/package.html
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/search/payloads/package.html?view=diff&rev=544713&r1=544712&r2=544713
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/search/payloads/package.html (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/search/payloads/package.html Tue Jun  5 19:57:03
2007
@@ -29,8 +29,15 @@
     <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>&nbsp;</DIV>
 <DIV align="center">
 </DIV>
 </BODY>
-</HTML>
\ No newline at end of file
+</HTML>



Mime
View raw message