Move model and record classes to records

This will eventually reduce boilerplate and provide a more consistent
experience for users. I am leaving the old getter methods as deprecated
for one major version to give users the ability to upgrade before having
to migrate to the updated accessors. There are other breaking changes,
but these will likely not affect most users.

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

…axmind/geoip2/record/AbstractRecord.java …com/maxmind/geoip2/JsonSerializable.javasrc/main/java/com/maxmind/geoip2/record/AbstractRecord.java renamed to src/main/java/com/maxmind/geoip2/JsonSerializable.java src/main/java/com/maxmind/geoip2/record/AbstractRecord.java renamed to src/main/java/com/maxmind/geoip2/JsonSerializable.java

@@ -1,38 +1,31 @@
-package com.maxmind.geoip2.record;
+package com.maxmind.geoip2;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import java.io.IOException;
 
 /**
- * Abstract class for GeoIP2.
+ * Interface for classes that can be serialized to JSON.
+ * Provides default implementation for toJson() method.
  */
-public abstract class AbstractRecord {
+public interface JsonSerializable {
 
     /**
      * @return JSON representation of this object. The structure is the same as
      * the JSON provided by the GeoIP2 web service.
      * @throws IOException if there is an error serializing the object to JSON.
      */
-    public String toJson() throws IOException {
+    default String toJson() throws IOException {
         JsonMapper mapper = JsonMapper.builder()
             .disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
+            .addModule(new JavaTimeModule())
             .serializationInclusion(JsonInclude.Include.NON_NULL)
             .serializationInclusion(JsonInclude.Include.NON_EMPTY)
             .build();
 
         return mapper.writeValueAsString(this);
     }
 
-    @Override
-    public String toString() {
-        // This exception should never happen. If it does happen, we did
-        // something wrong.
-        try {
-            return getClass().getName() + " [ " + toJson() + " ]";
-        } catch (IOException e) {
-            throw new RuntimeException(e);
-        }
-    }
 }

src/main/java/com/maxmind/geoip2/NamedRecord.java

@@ -0,0 +1,47 @@
+package com.maxmind.geoip2;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Interface for record classes that have localized names and GeoName IDs.
+ * Provides a default implementation for the name() method that returns the name
+ * in the first available locale.
+ */
+public interface NamedRecord extends JsonSerializable {
+
+    /**
+     * @return The GeoName ID for this location.
+     */
+    @JsonProperty("geoname_id")
+    Long geonameId();
+
+    /**
+     * @return A {@link Map} from locale codes to the name in that locale.
+     */
+    @JsonProperty("names")
+    Map<String, String> names();
+
+    /**
+     * @return The list of locales to use for name lookups.
+     */
+    @JsonIgnore
+    List<String> locales();
+
+    /**
+     * @return The name based on the locales list. Returns the name in the first
+     * locale for which a name is available. If no name is available in any of the
+     * specified locales, returns null.
+     */
+    @JsonIgnore
+    default String name() {
+        for (String lang : locales()) {
+            if (names().containsKey(lang)) {
+                return names().get(lang);
+            }
+        }
+        return null;
+    }
+}