8209304: Deprecate serialVersionUID fields in interfaces

Reviewed-by: lancea, mullan, rriggs, smarks
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.
+     *
+     * @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 = 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;

    /**
--- a/src/java.base/share/classes/javax/crypto/SecretKey.java
+++ b/src/java.base/share/classes/javax/crypto/SecretKey.java
@ -63,7 +63,11 @@ public interface SecretKey extends
    /**
     * The class fingerprint that is set to indicate serialization
     * compatibility since J2SE 1.4.
+     *
+     * @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 = -4795878709595146952L;
 }
--- a/src/java.base/share/classes/javax/crypto/interfaces/DHPrivateKey.java
+++ b/src/java.base/share/classes/javax/crypto/interfaces/DHPrivateKey.java
@ -41,8 +41,12 @@ public interface DHPrivateKey extends DHKey, java.security.PrivateKey {
    /**
     * The class fingerprint that is set to indicate serialization
     * compatibility since J2SE 1.4.
+     *
+     * @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 = 2211791113380396553L;

    /**
--- a/src/java.base/share/classes/javax/crypto/interfaces/DHPublicKey.java
+++ b/src/java.base/share/classes/javax/crypto/interfaces/DHPublicKey.java
@ -41,8 +41,12 @@ public interface DHPublicKey extends DHKey, java.security.PublicKey {
    /**
     * The class fingerprint that is set to indicate serialization
     * compatibility since J2SE 1.4.
+     *
+     * @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 = -6628103563352519193L;

    /**
--- a/src/java.base/share/classes/javax/crypto/interfaces/PBEKey.java
+++ b/src/java.base/share/classes/javax/crypto/interfaces/PBEKey.java
@ -41,8 +41,12 @@ public interface PBEKey extends javax.crypto.SecretKey {
    /**
     * The class fingerprint that is set to indicate serialization
     * compatibility since J2SE 1.4.
+     *
+     * @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 = -1430015993304333921L;

    /**
--- a/src/java.base/share/classes/sun/security/internal/interfaces/TlsMasterSecret.java
+++ b/src/java.base/share/classes/sun/security/internal/interfaces/TlsMasterSecret.java
@ -44,7 +44,12 @@ import javax.crypto.SecretKey;
@Deprecated
 public interface TlsMasterSecret extends SecretKey {

-    @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")
    public static final long serialVersionUID = -461748105810469773L;

    /**
--- a/src/java.naming/share/classes/javax/naming/Name.java
+++ b/src/java.naming/share/classes/javax/naming/Name.java
@ -63,8 +63,12 @@ public interface Name
    * 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 = -3617482732056931635L;

    /**
--- a/src/java.naming/share/classes/javax/naming/directory/Attribute.java
+++ b/src/java.naming/share/classes/javax/naming/directory/Attribute.java
@ -335,7 +335,11 @@ public interface Attribute extends Cloneable, java.io.Serializable {

    /**
     * Use serialVersionUID from JNDI 1.1.1 for interoperability.
+     *
+     * @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 = 8707690322213556804L;
 }
--- a/src/java.rmi/share/classes/java/rmi/server/RemoteRef.java
+++ b/src/java.rmi/share/classes/java/rmi/server/RemoteRef.java
@ -38,8 +38,13 @@ import java.rmi.*;
 */
 public interface RemoteRef extends java.io.Externalizable {

-    /** indicate compatibility with JDK 1.1.x version of class. */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    /** indicate compatibility with JDK 1.1.x version of class.
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
+     */
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = 3632638527362204081L;

    /**
--- a/src/java.rmi/share/classes/java/rmi/server/ServerRef.java
+++ b/src/java.rmi/share/classes/java/rmi/server/ServerRef.java
@ -38,8 +38,13 @@ import java.rmi.*;
@Deprecated
 public interface ServerRef extends RemoteRef {

-    /** indicate compatibility with JDK 1.1.x version of class. */
-    @SuppressWarnings("serial") // serialVersionUID in an interface is ineffectual
+    /** indicate compatibility with JDK 1.1.x version of class.
+     *
+     * @deprecated A {@code serialVersionUID} field in an interface is
+     * ineffectual. Do not use; no replacement.
+     */
+    @Deprecated
+    @SuppressWarnings("serial")
    static final long serialVersionUID = -4557750989390278438L;

    /**