Merge branch 'main' into dependabot/github_actions/github-actions-bb9…

…d44e1db

README.md

@@ -24,7 +24,7 @@ There are a few open-source projects that can convert Java objects to JSON. Howe
 Gradle:
 ```gradle
 dependencies {
-  implementation 'com.google.code.gson:gson:2.11.0'
+  implementation 'com.google.code.gson:gson:2.12.0'
 }
 ```
 
@@ -33,7 +33,7 @@ Maven:
 <dependency>
   <groupId>com.google.code.gson</groupId>
   <artifactId>gson</artifactId>
-  <version>2.11.0</version>
+  <version>2.12.0</version>
 </dependency>
 ```
 

UserGuide.md

@@ -76,7 +76,7 @@ The Gson instance does not maintain any state while invoking JSON operations. So
 
 ```gradle
 dependencies {
-    implementation 'com.google.code.gson:gson:2.11.0'
+    implementation 'com.google.code.gson:gson:2.12.0'
 }
 ```
 
@@ -90,7 +90,7 @@ To use Gson with Maven2/3, you can use the Gson version available in Maven Centr
     <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
-      <version>2.11.0</version>
+      <version>2.12.0</version>
       <scope>compile</scope>
     </dependency>
 </dependencies>

extras/pom.xml

@@ -19,7 +19,7 @@
   <parent>
     <groupId>com.google.code.gson</groupId>
     <artifactId>gson-parent</artifactId>
-    <version>2.11.1-SNAPSHOT</version>
+    <version>2.12.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>gson-extras</artifactId>
@@ -30,7 +30,7 @@
   <properties>
     <!-- Make the build reproducible, see root `pom.xml` -->
     <!-- This is duplicated here because that is recommended by `artifact:check-buildplan` -->
-    <project.build.outputTimestamp>2024-05-19T18:54:10Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2025-01-27T22:40:20Z</project.build.outputTimestamp>
 
     <!-- Overwrite property from parent; this module is currently not deployed -->
     <gson.isInternalModule>true</gson.isInternalModule>

gson/pom.xml

@@ -20,7 +20,7 @@
   <parent>
     <groupId>com.google.code.gson</groupId>
     <artifactId>gson-parent</artifactId>
-    <version>2.11.1-SNAPSHOT</version>
+    <version>2.12.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>gson</artifactId>
@@ -36,7 +36,7 @@
   <properties>
     <!-- Make the build reproducible, see root `pom.xml` -->
     <!-- This is duplicated here because that is recommended by `artifact:check-buildplan` -->
-    <project.build.outputTimestamp>2024-05-19T18:54:10Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2025-01-27T22:40:20Z</project.build.outputTimestamp>
 
     <excludeTestCompilation>**/Java17*</excludeTestCompilation>
   </properties>
@@ -66,13 +66,13 @@
     <dependency>
       <groupId>com.google.guava</groupId>
       <artifactId>guava-testlib</artifactId>
-      <version>33.3.1-jre</version>
+      <version>33.4.0-jre</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>com.google.guava</groupId>
       <artifactId>guava</artifactId>
-      <version>33.3.1-jre</version>
+      <version>33.4.0-jre</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -236,12 +236,12 @@
           <dependency>
             <groupId>com.guardsquare</groupId>
             <artifactId>proguard-base</artifactId>
-            <version>7.6.0</version>
+            <version>7.6.1</version>
           </dependency>
           <dependency>
             <groupId>com.guardsquare</groupId>
             <artifactId>proguard-core</artifactId>
-            <version>9.1.6</version>
+            <version>9.1.7</version>
           </dependency>
         </dependencies>
         <configuration>

gson/src/main/java/com/google/gson/GsonBuilder.java

@@ -710,7 +710,7 @@ public GsonBuilder registerTypeAdapter(Type type, Object typeAdapter) {
             || typeAdapter instanceof InstanceCreator<?>
             || typeAdapter instanceof TypeAdapter<?>);
 
-    if (isTypeObjectOrJsonElement(type)) {
+    if (hasNonOverridableAdapter(type)) {
       throw new IllegalArgumentException("Cannot override built-in adapter for " + type);
     }
 
@@ -730,9 +730,14 @@ public GsonBuilder registerTypeAdapter(Type type, Object typeAdapter) {
     return this;
   }
 
-  private static boolean isTypeObjectOrJsonElement(Type type) {
-    return type instanceof Class
-        && (type == Object.class || JsonElement.class.isAssignableFrom((Class<?>) type));
+  /** Whether the type has a built-in adapter which cannot be overridden. */
+  private static boolean hasNonOverridableAdapter(Type type) {
+    return type == Object.class;
+    // This should also cover `JsonElement.class.isAssignableFrom(type)`, however for backward
+    // compatibility this is not covered here because really old Gson versions had no built-in
+    // adapter for JsonElement so users registered custom adapters. These adapters don't have any
+    // effect in recent Gson versions. See
+    // https://github.com/google/gson/issues/2787#issuecomment-2581568157
   }
 
   /**
@@ -778,10 +783,6 @@ public GsonBuilder registerTypeHierarchyAdapter(Class<?> baseType, Object typeAd
             || typeAdapter instanceof JsonDeserializer<?>
             || typeAdapter instanceof TypeAdapter<?>);
 
-    if (JsonElement.class.isAssignableFrom(baseType)) {
-      throw new IllegalArgumentException("Cannot override built-in adapter for " + baseType);
-    }
-
     if (typeAdapter instanceof JsonDeserializer || typeAdapter instanceof JsonSerializer) {
       hierarchyFactories.add(TreeTypeAdapter.newTypeHierarchyFactory(baseType, typeAdapter));
     }

gson/src/main/java/com/google/gson/internal/bind/CollectionTypeAdapterFactory.java

@@ -49,10 +49,12 @@ public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> typeToken) {
 
     Type elementType = $Gson$Types.getCollectionElementType(type, rawType);
     TypeAdapter<?> elementTypeAdapter = gson.getAdapter(TypeToken.get(elementType));
+    TypeAdapter<?> wrappedTypeAdapter =
+        new TypeAdapterRuntimeTypeWrapper<>(gson, elementTypeAdapter, elementType);
     ObjectConstructor<T> constructor = constructorConstructor.get(typeToken);
 
     @SuppressWarnings({"unchecked", "rawtypes"}) // create() doesn't define a type parameter
-    TypeAdapter<T> result = new Adapter(gson, elementType, elementTypeAdapter, constructor);
+    TypeAdapter<T> result = new Adapter(wrappedTypeAdapter, constructor);
     return result;
   }
 
@@ -61,12 +63,8 @@ private static final class Adapter<E> extends TypeAdapter<Collection<E>> {
     private final ObjectConstructor<? extends Collection<E>> constructor;
 
     public Adapter(
-        Gson context,
-        Type elementType,
-        TypeAdapter<E> elementTypeAdapter,
-        ObjectConstructor<? extends Collection<E>> constructor) {
-      this.elementTypeAdapter =
-          new TypeAdapterRuntimeTypeWrapper<>(context, elementTypeAdapter, elementType);
+        TypeAdapter<E> elementTypeAdapter, ObjectConstructor<? extends Collection<E>> constructor) {
+      this.elementTypeAdapter = elementTypeAdapter;
       this.constructor = constructor;
     }
 

gson/src/main/java/com/google/gson/internal/bind/MapTypeAdapterFactory.java

@@ -132,15 +132,19 @@ public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> typeToken) {
     }
 
     Type[] keyAndValueTypes = $Gson$Types.getMapKeyAndValueTypes(type, rawType);
-    TypeAdapter<?> keyAdapter = getKeyAdapter(gson, keyAndValueTypes[0]);
-    TypeAdapter<?> valueAdapter = gson.getAdapter(TypeToken.get(keyAndValueTypes[1]));
+    Type keyType = keyAndValueTypes[0];
+    Type valueType = keyAndValueTypes[1];
+    TypeAdapter<?> keyAdapter = getKeyAdapter(gson, keyType);
+    TypeAdapter<?> wrappedKeyAdapter =
+        new TypeAdapterRuntimeTypeWrapper<>(gson, keyAdapter, keyType);
+    TypeAdapter<?> valueAdapter = gson.getAdapter(TypeToken.get(valueType));
+    TypeAdapter<?> wrappedValueAdapter =
+        new TypeAdapterRuntimeTypeWrapper<>(gson, valueAdapter, valueType);
     ObjectConstructor<T> constructor = constructorConstructor.get(typeToken);
 
     @SuppressWarnings({"unchecked", "rawtypes"})
     // we don't define a type parameter for the key or value types
-    TypeAdapter<T> result =
-        new Adapter(
-            gson, keyAndValueTypes[0], keyAdapter, keyAndValueTypes[1], valueAdapter, constructor);
+    TypeAdapter<T> result = new Adapter(wrappedKeyAdapter, wrappedValueAdapter, constructor);
     return result;
   }
 
@@ -157,15 +161,11 @@ private final class Adapter<K, V> extends TypeAdapter<Map<K, V>> {
     private final ObjectConstructor<? extends Map<K, V>> constructor;
 
     public Adapter(
-        Gson context,
-        Type keyType,
         TypeAdapter<K> keyTypeAdapter,
-        Type valueType,
         TypeAdapter<V> valueTypeAdapter,
         ObjectConstructor<? extends Map<K, V>> constructor) {
-      this.keyTypeAdapter = new TypeAdapterRuntimeTypeWrapper<>(context, keyTypeAdapter, keyType);
-      this.valueTypeAdapter =
-          new TypeAdapterRuntimeTypeWrapper<>(context, valueTypeAdapter, valueType);
+      this.keyTypeAdapter = keyTypeAdapter;
+      this.valueTypeAdapter = valueTypeAdapter;
       this.constructor = constructor;
     }
 

gson/src/main/java/com/google/gson/stream/JsonReader.java

@@ -431,7 +431,7 @@ public final Strictness getStrictness() {
    * <p>The default nesting limit is {@value #DEFAULT_NESTING_LIMIT}.
    *
    * @throws IllegalArgumentException if the nesting limit is negative.
-   * @since $next-version$
+   * @since 2.12.0
    * @see #getNestingLimit()
    */
   public final void setNestingLimit(int limit) {
@@ -444,7 +444,7 @@ public final void setNestingLimit(int limit) {
   /**
    * Returns the nesting limit of this reader.
    *
-   * @since $next-version$
+   * @since 2.12.0
    * @see #setNestingLimit(int)
    */
   public final int getNestingLimit() {

gson/src/test/java/com/google/gson/GsonBuilderTest.java

@@ -28,6 +28,7 @@
 import java.lang.reflect.Type;
 import java.text.DateFormat;
 import java.util.Date;
+import org.junit.Ignore;
 import org.junit.Test;
 
 /**
@@ -251,7 +252,10 @@ public void testSetStrictness() throws IOException {
   public void testRegisterTypeAdapterForObjectAndJsonElements() {
     String errorMessage = "Cannot override built-in adapter for ";
     Type[] types = {
-      Object.class, JsonElement.class, JsonArray.class,
+      Object.class,
+      // TODO: Registering adapter for JsonElement is allowed (for now) for backward compatibility,
+      //   see https://github.com/google/gson/issues/2787
+      // JsonElement.class, JsonArray.class,
     };
     GsonBuilder gsonBuilder = new GsonBuilder();
     for (Type type : types) {
@@ -263,6 +267,22 @@ public void testRegisterTypeAdapterForObjectAndJsonElements() {
     }
   }
 
+  /**
+   * Verifies that (for now) registering adapter for {@link JsonElement} and subclasses is possible,
+   * but has no effect. See {@link #testRegisterTypeAdapterForObjectAndJsonElements()}.
+   */
+  @Test
+  public void testRegisterTypeAdapterForJsonElements() {
+    Gson gson = new GsonBuilder().registerTypeAdapter(JsonArray.class, NULL_TYPE_ADAPTER).create();
+    TypeAdapter<JsonArray> adapter = gson.getAdapter(JsonArray.class);
+    // Does not use registered adapter
+    assertThat(adapter).isNotSameInstanceAs(NULL_TYPE_ADAPTER);
+    assertThat(adapter.toJson(new JsonArray())).isEqualTo("[]");
+  }
+
+  @Ignore(
+      "Registering adapter for JsonElement is allowed (for now) for backward compatibility, see"
+          + " https://github.com/google/gson/issues/2787")
   @Test
   public void testRegisterTypeHierarchyAdapterJsonElements() {
     String errorMessage = "Cannot override built-in adapter for ";
@@ -282,6 +302,20 @@ public void testRegisterTypeHierarchyAdapterJsonElements() {
     gsonBuilder.registerTypeHierarchyAdapter(Object.class, NULL_TYPE_ADAPTER);
   }
 
+  /**
+   * Verifies that (for now) registering hierarchy adapter for {@link JsonElement} and subclasses is
+   * possible, but has no effect. See {@link #testRegisterTypeHierarchyAdapterJsonElements()}.
+   */
+  @Test
+  public void testRegisterTypeHierarchyAdapterJsonElements_Allowed() {
+    Gson gson =
+        new GsonBuilder().registerTypeHierarchyAdapter(JsonArray.class, NULL_TYPE_ADAPTER).create();
+    TypeAdapter<JsonArray> adapter = gson.getAdapter(JsonArray.class);
+    // Does not use registered adapter
+    assertThat(adapter).isNotSameInstanceAs(NULL_TYPE_ADAPTER);
+    assertThat(adapter.toJson(new JsonArray())).isEqualTo("[]");
+  }
+
   @Test
   public void testSetDateFormatWithInvalidPattern() {
     GsonBuilder builder = new GsonBuilder();

gson/src/test/java/com/google/gson/JsonArrayAsListSuiteTest.java

@@ -42,10 +42,14 @@ public Iterable<JsonElement> order(List<JsonElement> insertionOrder) {
     @Override
     public List<JsonElement> create(Object... elements) {
       JsonArray array = new JsonArray();
+      // This is not completely accurate: Because there is no way to directly construct JsonArray or
+      // its List view with existing elements, this has to add the elements individually with
+      // `List#add`
+      var list = array.asList();
       for (Object element : elements) {
-        array.add((JsonElement) element);
+        list.add((JsonElement) element);
       }
-      return array.asList();
+      return list;
     }
   }
 
@@ -54,8 +58,6 @@ public static Test suite() {
     return ListTestSuiteBuilder.using(new ListGenerator())
         .withFeatures(
             CollectionSize.ANY,
-            // Note: There is current a Guava bug which causes 'null additions' to not be tested if
-            // 'null queries' is enabled, see https://github.com/google/guava/issues/7401
             CollectionFeature.ALLOWS_NULL_QUERIES,
             CollectionFeature.RESTRICTS_ELEMENTS, // List only allows JsonElement
             CollectionFeature.SUPPORTS_ADD,

gson/src/test/java/com/google/gson/JsonObjectAsMapSuiteTest.java

@@ -34,11 +34,15 @@ public SampleElements<Entry<String, JsonElement>> samples() {
     @Override
     public Map<String, JsonElement> create(Object... elements) {
       JsonObject object = new JsonObject();
+      // This is not completely accurate: Because there is no way to directly construct JsonObject
+      // or its Map view with existing entries, this has to add the entries individually with
+      // `Map#put`
+      var map = object.asMap();
       for (Object element : elements) {
         var entry = (Entry<?, ?>) element;
-        object.add((String) entry.getKey(), (JsonElement) entry.getValue());
+        map.put((String) entry.getKey(), (JsonElement) entry.getValue());
       }
-      return object.asMap();
+      return map;
     }
 
     @SuppressWarnings("unchecked")
@@ -70,8 +74,6 @@ public static Test suite() {
     return MapTestSuiteBuilder.using(new MapGenerator())
         .withFeatures(
             CollectionSize.ANY,
-            // Note: There is current a Guava bug which causes 'null additions' to not be tested if
-            // 'null queries' is enabled, see https://github.com/google/guava/issues/7401
             MapFeature.ALLOWS_ANY_NULL_QUERIES,
             MapFeature.RESTRICTS_KEYS, // Map only allows String keys
             MapFeature.RESTRICTS_VALUES, // Map only allows JsonElement values

gson/src/test/java/com/google/gson/internal/LinkedTreeMapSuiteTest.java

@@ -31,6 +31,8 @@ public MapGenerator(boolean allowNullValues) {
 
     @Override
     protected Map<String, String> create(Entry<String, String>[] entries) {
+      // This is not completely accurate: Because LinkedTreeMap has no constructor which accepts
+      // existing entries, this has to add the entries individually with `Map#put`
       var map = new LinkedTreeMap<String, String>(allowNullValues);
       for (var entry : entries) {
         map.put(entry.getKey(), entry.getValue());
@@ -47,8 +49,6 @@ private static Feature<?>[] createFeatures(Feature<?>... additionalFeatures) {
         new ArrayList<Feature<?>>(
             List.of(
                 CollectionSize.ANY,
-                // Note: There is current a Guava bug which causes 'null additions' to not be tested
-                // if 'null queries' is enabled, see https://github.com/google/guava/issues/7401
                 MapFeature.ALLOWS_ANY_NULL_QUERIES,
                 MapFeature.RESTRICTS_KEYS, // Map only allows comparable keys
                 MapFeature.SUPPORTS_PUT,
@@ -74,7 +74,8 @@ public static Test suite() {
             .named("nullValues=false")
             .createTestSuite();
 
-    TestSuite testSuite = new TestSuite("LinkedTreeMap");
+    // Use qualified class name to make it easier to find this test class in the IDE
+    TestSuite testSuite = new TestSuite(LinkedTreeMapSuiteTest.class.getName());
     testSuite.addTest(nullValuesSuite);
     testSuite.addTest(nonNullValuesSuite);
 

metrics/pom.xml

@@ -19,7 +19,7 @@
   <parent>
     <groupId>com.google.code.gson</groupId>
     <artifactId>gson-parent</artifactId>
-    <version>2.11.1-SNAPSHOT</version>
+    <version>2.12.1-SNAPSHOT</version>
   </parent>
 
   <artifactId>gson-metrics</artifactId>