Merge pull request #620 from maxmind/greg/eng-3230

Modernization changes for new major version

Author: oschwald

CHANGELOG.md

@@ -4,6 +4,18 @@ CHANGELOG
 5.0.0
 ------------------
 
+* **BREAKING:** All model and record classes have been converted to Java records.
+  This provides a more modern, immutable data model with automatic implementations
+  of `equals()`, `hashCode()`, and `toString()`. The abstract classes
+  `AbstractRecord`, `AbstractNamedRecord`, `AbstractResponse`,
+  `AbstractCountryResponse`, `AbstractCityResponse`, and `IpBaseResponse` have
+  been removed. Record components can be accessed using the new accessor methods
+  (e.g., `city()`, `country()`, `location()`). The traditional getter methods
+  (e.g., `getCity()`, `getCountry()`, `getLocation()`) are still available but
+  have been deprecated and will be removed in version 6.0.0.
+* **BREAKING:** `RepresentedCountry` is now a separate record type instead of
+  extending `Country`. It shares the same fields as `Country` but adds a `type`
+  field.
 * The deprecation notices for IP Risk database support have been removed.
   IP Risk database support will continue to be maintained.
 * **BREAKING:** The deprecated `WebServiceClient.Builder` methods
@@ -25,6 +37,11 @@ CHANGELOG
 * **BREAKING:** Removed no longer necessary `JacksonInject` annotations for
   `ip_address`, `network`, and `traits` from several classes. The
   `JsonInjector` class was removed.
+* Public getter methods in non-record classes (e.g., `DatabaseReader`,
+  exception classes) have been renamed to follow the same naming convention as
+  records (e.g., `metadata()` instead of `getMetadata()`). The old getter
+  methods are still available but have been deprecated and will be removed in
+  version 6.0.0.
 
 4.4.0 (2025-08-28)
 ------------------

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.maxmind.geoip2</groupId>
     <artifactId>geoip2</artifactId>
-    <version>4.4.0</version>
+    <version>5.0.0-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>MaxMind GeoIP2 API</name>
     <description>GeoIP2 webservice client and database reader</description>
@@ -36,11 +36,24 @@
             <email>[email protected]</email>
         </developer>
     </developers>
+    <repositories>
+        <repository>
+            <name>Central Portal Snapshots</name>
+            <id>central-portal-snapshots</id>
+            <url>https://central.sonatype.com/repository/maven-snapshots/</url>
+            <releases>
+                <enabled>false</enabled>
+            </releases>
+            <snapshots>
+                <enabled>true</enabled>
+            </snapshots>
+        </repository>
+    </repositories>
     <dependencies>
         <dependency>
             <groupId>com.maxmind.db</groupId>
             <artifactId>maxmind-db</artifactId>
-            <version>3.2.0</version>
+            <version>4.0.0-SNAPSHOT</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
@@ -294,10 +307,4 @@
             </build>
         </profile>
     </profiles>
-    <distributionManagement>
-        <repository>
-            <id>sonatype-nexus-staging</id>
-            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
-        </repository>
-    </distributionManagement>
 </project>