[Squirrel-sql-commits] SF.net SVN: squirrel-sql:[5605] trunk/sql12/app/src/net/sourceforge/ squirrel_sql/client/session/schemainfo/SchemaInfoCache.java

[<man...@us...>]

Revision: 5605
          http://squirrel-sql.svn.sourceforge.net/squirrel-sql/?rev=5605&view=rev
Author:   manningr
Date:     2010-05-01 15:24:40 +0000 (Sat, 01 May 2010)

Log Message:
-----------
Bug 2992443: Added warning to not introduce serialVersionUID and suppress warnings about it's absence.

Modified Paths:
--------------
    trunk/sql12/app/src/net/sourceforge/squirrel_sql/client/session/schemainfo/SchemaInfoCache.java

Modified: trunk/sql12/app/src/net/sourceforge/squirrel_sql/client/session/schemainfo/SchemaInfoCache.java
===================================================================
--- trunk/sql12/app/src/net/sourceforge/squirrel_sql/client/session/schemainfo/SchemaInfoCache.java	2010-04-30 01:36:00 UTC (rev 5604)
+++ trunk/sql12/app/src/net/sourceforge/squirrel_sql/client/session/schemainfo/SchemaInfoCache.java	2010-05-01 15:24:40 UTC (rev 5605)
@@ -25,6 +25,19 @@
 import net.sourceforge.squirrel_sql.fw.util.log.ILogger;
 import net.sourceforge.squirrel_sql.fw.util.log.LoggerController;
 
+/**
+ * This class is Serializable and yet doesn't declare serialVersionUID.  This is done intentionally so that 
+ * the SchemaInfoCacheSerializer can detect incompatible class changes (by catching Exception when attempting
+ * to read the serialized file).  This was deemed to be a less error-prone way of handling changes to this
+ * class file's definition, then having to remember to consider whether or not serialVersionUID should be 
+ * incremented for any given change.  Therefore, it is very important to not introduce a serialVersionUID
+ * class member, as forgetting to update it might lead to undetected incompatible class changes that don't 
+ * manifest themselves during de-serialization, but occur later in the application when missing members are
+ * invoked (for example).  This more conservative approach can lead to the serialized file being removed upon
+ * installing a newer version of SQuirreL more often than necessary, but it seemed to us to be better than the 
+ * alternative.
+ */
+@SuppressWarnings("serial")
 public class SchemaInfoCache implements Serializable
 {
    private static final ILogger s_log =


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.