[hibernate-commits] Hibernate SVN: r14715 - search/trunk/src/java/org/hibernate/search/backend.

[hibernate-commits at lists.jboss.org]

Author: epbernard
Date: 2008-05-30 10:50:47 -0400 (Fri, 30 May 2008)
New Revision: 14715

Modified:
   search/trunk/src/java/org/hibernate/search/backend/LuceneWork.java
   search/trunk/src/java/org/hibernate/search/backend/WorkQueue.java
Log:
Clarify the need for Serializability in LuceneWork

Modified: search/trunk/src/java/org/hibernate/search/backend/LuceneWork.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/backend/LuceneWork.java	2008-05-29 22:07:56 UTC (rev 14714)
+++ search/trunk/src/java/org/hibernate/search/backend/LuceneWork.java	2008-05-30 14:50:47 UTC (rev 14715)
@@ -8,6 +8,13 @@
 /**
  * Represent a Serializable Lucene unit work
  *
+ * WARNING: This class aims to be serializable and passed in an asynchronous way across VMs
+ *          any non backward compatible serialization change should be done with great care
+ *          and publically announced. Specifically, new versions of Hibernate Search should be
+ *          able to handle changes produced by older versions of Hibernate Search if reasonably possible.
+ *          That is why each subclass susceptible to be pass along have a magic serialization number.
+ *          NOTE: we are relying on Lucene's Document to play nice unfortunately
+ *
  * @author Emmanuel Bernard
  * @author Hardy Ferentschik
  */

Modified: search/trunk/src/java/org/hibernate/search/backend/WorkQueue.java
===================================================================
--- search/trunk/src/java/org/hibernate/search/backend/WorkQueue.java	2008-05-29 22:07:56 UTC (rev 14714)
+++ search/trunk/src/java/org/hibernate/search/backend/WorkQueue.java	2008-05-30 14:50:47 UTC (rev 14715)
@@ -10,7 +10,6 @@
  * @author Emmanuel Bernard
  */
 public class WorkQueue {
-	//TODO set a serial number
 	private List<Work> queue;
 
 	private List<LuceneWork> sealedQueue;