Javadoc comments for serialVersionUID.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@429439 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/lang/CharRange.java

@@ -31,7 +31,11 @@
  */
 public final class CharRange implements Serializable {
 
-    /** Serialization lock, Lang version 2.0. */
+    /**
+     * Required for serialization support. Lang version 2.0. 
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 8270183163158333422L;
     
     /** The first character, inclusive, in the range. */

src/java/org/apache/commons/lang/CharSet.java

@@ -37,7 +37,11 @@
  */
 public class CharSet implements Serializable {
 
-    /** Serialization lock, Lang version 2.0. */
+    /**
+     * Required for serialization support. Lang version 2.0. 
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 5947847346149275958L;
 
     /** 

src/java/org/apache/commons/lang/IllegalClassException.java

@@ -43,7 +43,11 @@
  */
 public class IllegalClassException extends IllegalArgumentException {
 
-    /** Serialization version. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 8063272569377254819L;
 
     /**

src/java/org/apache/commons/lang/IncompleteArgumentException.java

@@ -46,7 +46,11 @@
  */
 public class IncompleteArgumentException extends IllegalArgumentException {
 
-    /** Serialization version. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 4954193403612068178L;
 
     /**

src/java/org/apache/commons/lang/NotImplementedException.java

@@ -53,7 +53,11 @@ public class NotImplementedException
 
     private static final String DEFAULT_MESSAGE = "Code is not implemented";
 
-    /** Serialization version. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -6894122266938754088L;
 
     /**

src/java/org/apache/commons/lang/NullArgumentException.java

@@ -44,7 +44,11 @@
  */
 public class NullArgumentException extends IllegalArgumentException {
 
-    /** Serialization version. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1174360235354917591L;
 
     /**

src/java/org/apache/commons/lang/ObjectUtils.java

@@ -252,7 +252,11 @@ public static String toString(Object obj, String nullStr) {
      * cannot be stored.</p>
      */
     public static class Null implements Serializable {
-        // declare serialization compatibility with Commons Lang 1.0
+        /**
+         * Required for serialization support. Declare serialization compatibility with Commons Lang 1.0
+         * 
+         * @see java.io.Serializable
+         */
         private static final long serialVersionUID = 7092611880189329093L;
         
         /**

src/java/org/apache/commons/lang/SerializationException.java

@@ -28,7 +28,11 @@
  */
 public class SerializationException extends NestableRuntimeException {
 
-    /** Serialization version. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 4029025366392702726L;
 
     /**

src/java/org/apache/commons/lang/UnhandledException.java

@@ -43,7 +43,11 @@
  */
 public class UnhandledException extends NestableRuntimeException {
 
-    /** Serialization version. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1832101364842773720L;
 
     /**

src/java/org/apache/commons/lang/builder/StandardToStringStyle.java

@@ -32,6 +32,11 @@
  */
 public class StandardToStringStyle extends ToStringStyle {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**

src/java/org/apache/commons/lang/builder/ToStringStyle.java

@@ -1981,6 +1981,11 @@ protected void setSummaryObjectEndText(String summaryObjectEndText) {
      */
     private static final class DefaultToStringStyle extends ToStringStyle {
 
+        /**
+         * Required for serialization support.
+         * 
+         * @see java.io.Serializable
+         */
         private static final long serialVersionUID = 1L;
 
         /**

src/java/org/apache/commons/lang/enum/Enum.java

@@ -237,7 +237,11 @@
  */
 public abstract class Enum implements Comparable, Serializable {
 
-    /** Lang version 1.0.1 serial compatibility */
+    /**
+     * Required for serialization support. Lang version 1.0.1 serial compatibility.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -487045951170455942L;
     
     // After discussion, the default size for HashMaps is used, as the

src/java/org/apache/commons/lang/enum/ValuedEnum.java

@@ -103,7 +103,11 @@
  */
 public abstract class ValuedEnum extends Enum {
     
-    /** Lang version 1.0.1 serial compatibility */
+    /**
+     * Required for serialization support. Lang version 1.0.1 serial compatibility.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -7129650521543789085L;
     
     /**

src/java/org/apache/commons/lang/exception/NestableDelegate.java

@@ -45,6 +45,11 @@
  */
 public class NestableDelegate implements Serializable {
 
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**

src/java/org/apache/commons/lang/exception/NestableError.java

@@ -28,6 +28,11 @@
  */
 public class NestableError extends Error implements Nestable {
 
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**

src/java/org/apache/commons/lang/exception/NestableException.java

@@ -88,6 +88,11 @@
  */
 public class NestableException extends Exception implements Nestable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**

src/java/org/apache/commons/lang/exception/NestableRuntimeException.java

@@ -32,6 +32,11 @@
  */
 public class NestableRuntimeException extends RuntimeException implements Nestable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**

src/java/org/apache/commons/lang/math/DoubleRange.java

@@ -26,6 +26,11 @@
  */
 public final class DoubleRange extends Range implements Serializable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 71849363892740L;
 
     /**

src/java/org/apache/commons/lang/math/FloatRange.java

@@ -26,6 +26,11 @@
  */
 public final class FloatRange extends Range implements Serializable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 71849363892750L;
 
     /**

src/java/org/apache/commons/lang/math/Fraction.java

@@ -35,7 +35,11 @@
  */
 public final class Fraction extends Number implements Serializable, Comparable {
 
-    /** Serialization lock, Lang version 2.0 */
+    /**
+     * Required for serialization support. Lang version 2.0.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 65382027393090L;
 
     /**

src/java/org/apache/commons/lang/math/IntRange.java

@@ -26,6 +26,11 @@
  */
 public final class IntRange extends Range implements Serializable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 71849363892730L;
 
     /**

src/java/org/apache/commons/lang/math/JVMRandom.java

@@ -28,6 +28,11 @@
  */
 public final class JVMRandom extends Random {
 
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**

src/java/org/apache/commons/lang/math/LongRange.java

@@ -26,6 +26,11 @@
  */
 public final class LongRange extends Range implements Serializable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 71849363892720L;
 
     /**

src/java/org/apache/commons/lang/math/NumberRange.java

@@ -28,6 +28,11 @@
  */
 public final class NumberRange extends Range implements Serializable {
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 71849363892710L;
 
     /**

src/java/org/apache/commons/lang/mutable/MutableBoolean.java

@@ -28,7 +28,11 @@
  */
 public class MutableBoolean implements Mutable, Serializable, Comparable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -4830728138360036487L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableByte.java

@@ -24,7 +24,11 @@
  */
 public class MutableByte extends Number implements Comparable, Mutable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -1585823265L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableDouble.java

@@ -26,7 +26,11 @@
  */
 public class MutableDouble extends Number implements Comparable, Mutable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1587163916L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableFloat.java

@@ -26,7 +26,11 @@
  */
 public class MutableFloat extends Number implements Comparable, Mutable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 5787169186L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableInt.java

@@ -24,7 +24,11 @@
  */
 public class MutableInt extends Number implements Comparable, Mutable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 512176391864L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableLong.java

@@ -24,7 +24,11 @@
  */
 public class MutableLong extends Number implements Comparable, Mutable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 62986528375L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableObject.java

@@ -26,7 +26,11 @@
  */
 public class MutableObject implements Mutable, Serializable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 86241875189L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/mutable/MutableShort.java

@@ -24,7 +24,11 @@
  */
 public class MutableShort extends Number implements Comparable, Mutable {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -2135791679L;
 
     /** The mutable value. */

src/java/org/apache/commons/lang/text/CompositeFormat.java

@@ -30,7 +30,11 @@
  */
 public class CompositeFormat extends Format {
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = -4329119827877627683L;
 
     /** The parser to use. */

src/java/org/apache/commons/lang/text/StrBuilder.java

@@ -73,7 +73,11 @@ public class StrBuilder implements Cloneable {
      */
     static final int CAPACITY = 32;
 
-    /** Serialization lock. */
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 7628716375283629643L;
 
     /** Internal data storage. */

src/java/org/apache/commons/lang/time/FastDateFormat.java

@@ -78,6 +78,11 @@ public class FastDateFormat extends Format {
     // taking the value and adding (mathematically) the ASCII value for '0'.
     // So, don't change this code! It works and is very fast.
     
+    /**
+     * Required for serialization support.
+     * 
+     * @see java.io.Serializable
+     */
     private static final long serialVersionUID = 1L;
 
     /**