Explicitly deprecate some constructors

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+2.16.0
+-------------------
+
+* Deprecated model constructors that exist for backwards compatibility.
+  These constructors are not generally used by users of this library
+  directly except perhaps when mocking the reader in tests.
+
 2.15.0 (2020-10-14)
 -------------------
 

src/main/java/com/maxmind/geoip2/model/AnonymousIpResponse.java

@@ -28,8 +28,10 @@ public class AnonymousIpResponse extends AbstractResponse {
         this(null, false, false, false, false, false);
     }
 
-    // This is for compatibility and should be removed if we do a major release.
-    public AnonymousIpResponse(
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */    public AnonymousIpResponse(
             String ipAddress,
             boolean isAnonymous,
             boolean isAnonymousVpn,
@@ -40,8 +42,10 @@ public AnonymousIpResponse(
         this(ipAddress, isAnonymous, isAnonymousVpn, isHostingProvider, isPublicProxy, isTorExitNode, null);
     }
 
-    // This is for compatibility and should be removed if we do a major release.
-    public AnonymousIpResponse(
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */    public AnonymousIpResponse(
             String ipAddress,
             boolean isAnonymous,
             boolean isAnonymousVpn,

src/main/java/com/maxmind/geoip2/model/AsnResponse.java

@@ -24,6 +24,10 @@ public class AsnResponse extends AbstractResponse {
         this((Integer) null, null, null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public AsnResponse(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,

src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java

@@ -68,6 +68,10 @@ public static ConnectionType fromString(String s) {
         this(null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public ConnectionTypeResponse(
             ConnectionType connectionType,
             String ipAddress

src/main/java/com/maxmind/geoip2/model/DomainResponse.java

@@ -23,6 +23,10 @@ public class DomainResponse extends AbstractResponse {
         this(null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public DomainResponse(
             String domain,
             String ipAddress

src/main/java/com/maxmind/geoip2/model/IspResponse.java

@@ -20,6 +20,10 @@ public class IspResponse extends AsnResponse {
         this(null, null, null, null, null);
     }
 
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public IspResponse(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,

src/main/java/com/maxmind/geoip2/record/Country.java

@@ -30,8 +30,10 @@ public Country() {
         this(null, null, (Integer) null, false, null, null);
     }
 
-    // This method is for backwards compatibility. We should remove it when we
-    // do a major release.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public Country(
             List<String> locales,
             Integer confidence,

src/main/java/com/maxmind/geoip2/record/RepresentedCountry.java

@@ -30,8 +30,10 @@ public RepresentedCountry() {
         this(null, null, (Integer) null, false, null, null, null);
     }
 
-    // This method is for backwards compatibility. We should remove it when we
-    // do a major release.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public RepresentedCountry(
             List<String> locales,
             Integer confidence,

src/main/java/com/maxmind/geoip2/record/Traits.java

@@ -57,8 +57,10 @@ public Traits(String ipAddress, Network network) {
                 network, null, null, null, null);
     }
 
-    // This is for back-compat. If we ever do a major release, it should be
-    // removed.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public Traits(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,
@@ -75,8 +77,10 @@ public Traits(
                 organization, userType);
     }
 
-    // This is for back-compat. If we ever do a major release, it should be
-    // removed.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public Traits(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,
@@ -95,8 +99,10 @@ public Traits(
                 false, isSatelliteProvider, false, isp, null, organization, userType, null, null);
     }
 
-    // This is for back-compat. If we ever do a major release, it should be
-    // removed.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public Traits(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,
@@ -121,8 +127,10 @@ public Traits(
                 null, organization, userType, null, null);
     }
 
-    // This is for back-compat. If we ever do a major release, it should be
-    // removed.
+    /**
+     * @deprecated This constructor exists for backwards compatibility. Will be
+     * removed in the next major release.
+     */
     public Traits(
             Integer autonomousSystemNumber,
             String autonomousSystemOrganization,