8209304: Deprecate serialVersionUID fields in interfaces

Reviewed-by: lancea, mullan, rriggs, smarks
2025-08-27 06:45:07 +02:00 · 2018-08-17 13:37:01 -07:00 · 2018-08-17 13:37:01 -07:00 · 07ed14c5cf
commit 07ed14c5cf
parent 4dfa58d553
20 changed files with 106 additions and 23 deletions
--- a/src/java.base/share/classes/java/security/Key.java
+++ b/src/java.base/share/classes/java/security/Key.java
@ -108,8 +108,12 @@ public interface Key extends java.io.Serializable {
    * The class fingerprint that is set to indicate
    * serialization compatibility with a previous
    * version of the class.
+    *
+    * @deprecated A {@code serialVersionUID} field in an interface is
+    * ineffectual. Do not use; no replacement.
    */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 6603384152749567654L;

    /**
--- a/src/java.base/share/classes/java/security/PrivateKey.java
+++ b/src/java.base/share/classes/java/security/PrivateKey.java
@ -63,7 +63,11 @@ public interface PrivateKey extends Key, javax.security.auth.Destroyable {
    /**
     * The class fingerprint that is set to indicate serialization
     * compatibility with a previous version of the class.
-     */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
+      */
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 6034044314589513430L;
 }
--- a/src/java.base/share/classes/java/security/PublicKey.java
+++ b/src/java.base/share/classes/java/security/PublicKey.java
@ -49,7 +49,11 @@ public interface PublicKey extends Key {
    /**
     * The class fingerprint that is set to indicate serialization
     * compatibility with a previous version of the class.
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
     */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 7187392471159151072L;
 }
--- a/src/java.base/share/classes/java/security/interfaces/DSAPrivateKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/DSAPrivateKey.java
@ -47,8 +47,12 @@ public interface DSAPrivateKey extends DSAKey, java.security.PrivateKey {
    * The class fingerprint that is set to indicate
    * serialization compatibility with a previous
    * version of the class.
+    *
+    * @deprecated A {@code serialVersionUID} field in an interface is
+    * ineffectual. Do not use; no replacement.
    */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 7776497482533790279L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/DSAPublicKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/DSAPublicKey.java
@ -47,8 +47,12 @@ public interface DSAPublicKey extends DSAKey, java.security.PublicKey {
    * The class fingerprint that is set to indicate
    * serialization compatibility with a previous
    * version of the class.
+    *
+    * @deprecated A {@code serialVersionUID} field in an interface is
+    * ineffectual. Do not use; no replacement.
    */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 1234526332779022332L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/ECPrivateKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/ECPrivateKey.java
@ -42,8 +42,12 @@ public interface ECPrivateKey extends PrivateKey, ECKey {
   /**
    * The class fingerprint that is set to indicate
    * serialization compatibility.
+    *
+    * @deprecated A {@code serialVersionUID} field in an interface is
+    * ineffectual. Do not use; no replacement.
    */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = -7896394956925609184L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/ECPublicKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/ECPublicKey.java
@ -44,8 +44,12 @@ public interface ECPublicKey extends PublicKey, ECKey {
   /**
    * The class fingerprint that is set to indicate
    * serialization compatibility.
+    *
+    * @deprecated A {@code serialVersionUID} field in an interface is
+    * ineffectual. Do not use; no replacement.
    */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = -3314988629879632826L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/RSAMultiPrimePrivateCrtKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/RSAMultiPrimePrivateCrtKey.java
@ -50,8 +50,12 @@ public interface RSAMultiPrimePrivateCrtKey extends RSAPrivateKey {
     * The type fingerprint that is set to indicate
     * serialization compatibility with a previous
     * version of the type.
+    *
+    * @deprecated A {@code serialVersionUID} field in an interface is
+    * ineffectual. Do not use; no replacement.
     */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 618058533534628008L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/RSAPrivateCrtKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/RSAPrivateCrtKey.java
@ -45,8 +45,12 @@ public interface RSAPrivateCrtKey extends RSAPrivateKey {
     * The type fingerprint that is set to indicate
     * serialization compatibility with a previous
     * version of the type.
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
     */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = -5682214253527700368L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/RSAPrivateKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/RSAPrivateKey.java
@ -44,8 +44,12 @@ public interface RSAPrivateKey extends java.security.PrivateKey, RSAKey
     * The type fingerprint that is set to indicate
     * serialization compatibility with a previous
     * version of the type.
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
     */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 5187144804936595022L;

    /**
--- a/src/java.base/share/classes/java/security/interfaces/RSAPublicKey.java
+++ b/src/java.base/share/classes/java/security/interfaces/RSAPublicKey.java
@ -41,8 +41,12 @@ public interface RSAPublicKey extends java.security.PublicKey, RSAKey
     * The type fingerprint that is set to indicate
     * serialization compatibility with a previous
     * version of the type.
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
     */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = -8727434096241101194L;

    /**