[jboss-svn-commits] JBoss Portal SVN: r5255 - trunk/portlet/src/main/org/jboss/portal/portlet/impl/state

[jboss-svn-commits at lists.jboss.org]

Author: julien at jboss.com
Date: 2006-09-25 20:45:55 -0400 (Mon, 25 Sep 2006)
New Revision: 5255

Modified:
   trunk/portlet/src/main/org/jboss/portal/portlet/impl/state/StateConverterV0.java
Log:
added javadoc that explains the purpose of the state converter implementation.

Modified: trunk/portlet/src/main/org/jboss/portal/portlet/impl/state/StateConverterV0.java
===================================================================
--- trunk/portlet/src/main/org/jboss/portal/portlet/impl/state/StateConverterV0.java	2006-09-26 00:41:05 UTC (rev 5254)
+++ trunk/portlet/src/main/org/jboss/portal/portlet/impl/state/StateConverterV0.java	2006-09-26 00:45:55 UTC (rev 5255)
@@ -38,6 +38,13 @@
 import java.util.Map;
 
 /**
+ * <p>An implementation that relies on the <code>DataInputStream</code> and <code>DataOutputStream</code> to
+ * marshall and unmarshall the producer state. The marshalled value starts with a magic value and a version id
+ * to ensure future backward compatibility.</p>
+ *
+ * <p>It is an important matter because a migrated producer will probably
+ * have to take care of consumers that hold a previous version of the producer state.</p>
+ *
  * @author <a href="mailto:julien at jboss.org">Julien Viet</a>
  * @version $Revision: 1.1 $
  */