svn commit: r682689 - in /lucene/java/trunk: CHANGES.txt src/java/org/apache/lucene/document/Fieldable.java

[gs...@apache.org]

Author: gsingers
Date: Tue Aug  5 05:27:42 2008
New Revision: 682689

URL: http://svn.apache.org/viewvc?rev=682689&view=rev
Log:
LUCENE-1349: Mark Fieldable as changeable

Modified:
    lucene/java/trunk/CHANGES.txt
    lucene/java/trunk/src/java/org/apache/lucene/document/Fieldable.java

Modified: lucene/java/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/java/trunk/CHANGES.txt?rev=682689&r1=682688&r2=682689&view=diff
==============================================================================
--- lucene/java/trunk/CHANGES.txt (original)
+++ lucene/java/trunk/CHANGES.txt Tue Aug  5 05:27:42 2008
@@ -1,6 +1,13 @@
 Lucene Change Log
 $Id$
 
+NOTE:  In a minor change to Lucene's backward compatibility policy, we are now allowing the Fieldable interface to have
+changes, within reason, and made on a case-by-case basis.  If an application implements it's own Fieldable, please be aware
+  of this.  Otherwise, no need to be concerned.  For more details see https://issues.apache.org/jira/browse/LUCENE-1349.
+  This is in effect for all 2.X releases, starting with 2.4.  Also note, that in all likelihood, Fieldable will be changed
+  in 3.0.
+
+
 ======================= Trunk (not yet released) =======================
 
 Changes in runtime behavior

Modified: lucene/java/trunk/src/java/org/apache/lucene/document/Fieldable.java
URL: http://svn.apache.org/viewvc/lucene/java/trunk/src/java/org/apache/lucene/document/Fieldable.java?rev=682689&r1=682688&r2=682689&view=diff
==============================================================================
--- lucene/java/trunk/src/java/org/apache/lucene/document/Fieldable.java (original)
+++ lucene/java/trunk/src/java/org/apache/lucene/document/Fieldable.java Tue Aug  5 05:27:42 2008
@@ -16,14 +16,20 @@
  * limitations under the License.
  */
 
+import org.apache.lucene.analysis.TokenStream;
+
 import java.io.Reader;
 import java.io.Serializable;
 
-import org.apache.lucene.analysis.TokenStream;
-
 /**
  * Synonymous with {@link Field}.
  *
+ * <p><bold>WARNING</bold>: This interface may change within minor versions, despite Lucene's backward compatibility requirements.
+ * This means new methods may be added from version to version.  This change only affects the Fieldable API; other backwards
+ * compatibility promises remain intact. For example, Lucene can still
+ * read and write indices created within the same major version.
+ * </p>
+ *
  **/
 public interface Fieldable extends Serializable {
   /** Sets the boost factor hits on this field.  This value will be