Warnings removal, cosmetic changes

Author: cowtowncoder

avro/src/main/java/com/fasterxml/jackson/dataformat/avro/schema/RecordVisitor.java

@@ -26,15 +26,16 @@ public class RecordVisitor
     protected final VisitorFormatWrapperImpl _visitorWrapper;
 
     /**
-     * Tracks if the schema for this record has been overridden (by an annotation or other means), and calls to the {@code property} and
-     * {@code optionalProperty} methods should be ignored.
+     * Tracks if the schema for this record has been overridden (by an annotation or other means),
+     * and calls to the {@code property} and {@code optionalProperty} methods should be ignored.
      */
     protected final boolean _overridden;
 
     /**
-     * When Avro schema for this JavaType ({@code _type}) results in UNION of multiple Avro types, _typeSchema keeps track
-     * which Avro type in the UNION represents this JavaType ({@code _type}) so that fields of this JavaType can be set to the right Avro type by {@code builtAvroSchema()}.
-     *
+     * When Avro schema for this JavaType ({@code _type}) results in UNION of multiple Avro types,
+     * _typeSchema keeps track of which Avro type in the UNION represents this JavaType ({@code _type})
+     * so that fields of this JavaType can be set to the right Avro type by {@code builtAvroSchema()}.
+     *<br>
      * Example:
      * <pre>
      *   @JsonSubTypes({
@@ -45,7 +46,7 @@ public class RecordVisitor
      *   class Apple extends Fruit {}
      *   class Orange extends Fruit {}
      * </pre>
-     * When _type = Fruit.class
+     * When {@code _type = Fruit.class}
      * Then
      * _avroSchema if Fruit.class is union of Fruit record, Apple record and Orange record schemas: [
      *     { name: Fruit, type: record, fields: [..] }, <--- _typeSchema points here
@@ -56,10 +57,15 @@ public class RecordVisitor
      *
      * FIXME: When _typeSchema is not null, then _overridden must be true, therefore (_overridden == true) can be replaced with (_typeSchema != null),
      * but it might be considered API change cause _overridden has protected access modifier.
+     *
+     * @since 2.19.1
      */
-    private Schema _typeSchema;
+    private final Schema _typeSchema;
+
+    // !!! 19-May-2025: TODO: make final in 2.20
     protected Schema _avroSchema;
 
+    // !!! 19-May-2025: TODO: make final in 2.20
     protected List<Schema.Field> _fields = new ArrayList<>();
 
     public RecordVisitor(SerializerProvider p, JavaType type, VisitorFormatWrapperImpl visitorWrapper)
@@ -73,6 +79,7 @@ public RecordVisitor(SerializerProvider p, JavaType type, VisitorFormatWrapperIm
         if (ann != null) {
             _avroSchema = AvroSchemaHelper.parseJsonSchema(ann.value());
             _overridden = true;
+            _typeSchema = null;
         } else {
             // If Avro schema for this _type results in UNION I want to know Avro type where to assign fields
             _typeSchema = AvroSchemaHelper.initializeRecordSchema(bean);
@@ -89,12 +96,14 @@ public RecordVisitor(SerializerProvider p, JavaType type, VisitorFormatWrapperIm
                 Set<Class<?>> alreadySeenClasses = new HashSet<>();
                 alreadySeenClasses.add(_type.getRawClass());
 
-                // At this point calculating hashCode for _typeSchema fails with NPE because RecordSchema.fields is NULL
-                // see org.apache.avro.Schema.RecordSchema#computeHash.
-                // Therefore, unionSchemas must not be HashSet (or any other type using hashCode() for equality check).
+                // At this point calculating hashCode for _typeSchema fails with
+                // NPE because RecordSchema.fields is NULL
+                // (see org.apache.avro.Schema.RecordSchema#computeHash).
+                // Therefore, unionSchemas must not be HashSet (or any other type
+                // using hashCode() for equality check).
                 // Set ensures that each subType schema is once in resulting union.
                 // IdentityHashMap is used because it is using reference-equality.
-                Set<Schema> unionSchemas = Collections.newSetFromMap(new IdentityHashMap<>());
+                final Set<Schema> unionSchemas = Collections.newSetFromMap(new IdentityHashMap<>());
                 // Initialize with this schema
                 if (_type.isConcrete()) {
                     unionSchemas.add(_typeSchema);

avro/src/test/java/com/fasterxml/jackson/dataformat/avro/schema/PolymorphicTypeAnnotationsTest.java

@@ -1,14 +1,13 @@
 package com.fasterxml.jackson.dataformat.avro.schema;
 
+import org.junit.jupiter.api.Test;
+
 import com.fasterxml.jackson.annotation.JsonSubTypes;
-import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.dataformat.avro.AvroMapper;
 import com.fasterxml.jackson.dataformat.avro.annotation.AvroNamespace;
+
 import org.apache.avro.Schema;
 import org.apache.avro.reflect.Union;
-import org.junit.jupiter.api.Test;
-
-import java.io.IOException;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -22,31 +21,31 @@ public class PolymorphicTypeAnnotationsTest {
             @JsonSubTypes.Type(value = Cat.class),
             @JsonSubTypes.Type(value = Dog.class),
     })
-    private interface AnimalInterface {
+    interface AnimalInterface {
     }
 
-    private static abstract class AbstractMammal implements AnimalInterface {
+    static abstract class AbstractMammal implements AnimalInterface {
         public int legs;
     }
 
-    private static class Cat extends AbstractMammal {
+    static class Cat extends AbstractMammal {
         public String color;
     }
 
-    private static class Dog extends AbstractMammal {
+    static class Dog extends AbstractMammal {
         public int size;
     }
 
     @Test
-    public void subclasses_of_interface_test() throws JsonMappingException {
+    public void subclasses_of_interface_test() throws Exception {
         // GIVEN
         final Schema catSchema = MAPPER.schemaFor(Cat.class).getAvroSchema();
         final Schema dogSchema = MAPPER.schemaFor(Dog.class).getAvroSchema();
 
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(AnimalInterface.class).getAvroSchema();
 
-        System.out.println("Animal schema:\n" + actualSchema.toString(true));
+        // System.out.println("Animal schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
@@ -59,22 +58,22 @@ public void subclasses_of_interface_test() throws JsonMappingException {
             @JsonSubTypes.Type(value = Pear.class),
     })
     @AvroNamespace(TEST_NAMESPACE) // @AvroNamespace makes it easier to create schema string representation
-    private static class Fruit {
+    static class Fruit {
         public boolean eatable;
     }
 
     private static final String FRUIT_ITSELF_SCHEMA_STR = "{\"type\":\"record\",\"name\":\"Fruit\",\"namespace\":\"test\",\"fields\":[{\"name\":\"eatable\",\"type\":\"boolean\"}]}";
 
-    private static class Apple extends Fruit {
+    static class Apple extends Fruit {
         public String color;
     }
 
-    private static class Pear extends Fruit {
+    static class Pear extends Fruit {
         public int seeds;
     }
 
     @Test
-    public void jsonSubTypes_on_concrete_class_test() throws IOException {
+    public void jsonSubTypes_on_concrete_class_test() throws Exception {
         // GIVEN
         final Schema fruitItselfSchema = MAPPER.schemaFrom(FRUIT_ITSELF_SCHEMA_STR).getAvroSchema();
         final Schema appleSchema = MAPPER.schemaFor(Apple.class).getAvroSchema();
@@ -83,7 +82,7 @@ public void jsonSubTypes_on_concrete_class_test() throws IOException {
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(Fruit.class).getAvroSchema();
 
-        System.out.println("Fruit schema:\n" + actualSchema.toString(true));
+        // System.out.println("Fruit schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
@@ -95,7 +94,7 @@ public void jsonSubTypes_on_concrete_class_test() throws IOException {
             @JsonSubTypes.Type(value = AbstractWaterVehicle.class),
     })
     @AvroNamespace(TEST_NAMESPACE)
-    private static class Vehicle {
+    static class Vehicle {
     }
 
     private static final String VEHICLE_ITSELF_SCHEMA_STR = "{\"type\":\"record\",\"name\":\"Vehicle\",\"namespace\":\"test\",\"fields\":[]}";
@@ -105,33 +104,33 @@ private static class Vehicle {
             @JsonSubTypes.Type(value = MotorCycle.class),
     })
     @AvroNamespace(TEST_NAMESPACE)
-    private static class LandVehicle extends Vehicle {
+    static class LandVehicle extends Vehicle {
     }
 
     private static final String LAND_VEHICLE_ITSELF_SCHEMA_STR = "{\"type\":\"record\",\"name\":\"LandVehicle\",\"namespace\":\"test\",\"fields\":[]}";
 
-    private static class Car extends LandVehicle {
+    static class Car extends LandVehicle {
     }
 
-    private static class MotorCycle extends LandVehicle {
+    static class MotorCycle extends LandVehicle {
     }
 
     @JsonSubTypes({
             @JsonSubTypes.Type(value = Boat.class),
             @JsonSubTypes.Type(value = Submarine.class),
     })
-    private static abstract class AbstractWaterVehicle extends Vehicle {
+    static abstract class AbstractWaterVehicle extends Vehicle {
         public int propellers;
     }
 
-    private static class Boat extends AbstractWaterVehicle {
+    static class Boat extends AbstractWaterVehicle {
     }
 
-    private static class Submarine extends AbstractWaterVehicle {
+    static class Submarine extends AbstractWaterVehicle {
     }
 
     @Test
-    public void jsonSubTypes_of_jsonSubTypes_test() throws IOException {
+    public void jsonSubTypes_of_jsonSubTypes_test() throws Exception {
         // GIVEN
         final Schema vehicleItselfSchema = MAPPER.schemaFrom(VEHICLE_ITSELF_SCHEMA_STR).getAvroSchema();
         final Schema landVehicleItselfSchema = MAPPER.schemaFrom(LAND_VEHICLE_ITSELF_SCHEMA_STR).getAvroSchema();
@@ -143,7 +142,7 @@ public void jsonSubTypes_of_jsonSubTypes_test() throws IOException {
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(Vehicle.class).getAvroSchema();
 
-        System.out.println("Vehicle schema:\n" + actualSchema.toString(true));
+        // System.out.println("Vehicle schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
@@ -180,15 +179,15 @@ private static class Oxygen extends AbstractGas {
     }
 
     @Test
-    public void class_is_referenced_twice_in_hierarchy_test() throws JsonMappingException {
+    public void class_is_referenced_twice_in_hierarchy_test() throws Exception {
         // GIVEN
         final Schema heliumSchema = MAPPER.schemaFor(Helium.class).getAvroSchema();
         final Schema oxygenSchema = MAPPER.schemaFor(Oxygen.class).getAvroSchema();
 
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(ElementInterface.class).getAvroSchema();
 
-        System.out.println("ElementInterface schema:\n" + actualSchema.toString(true));
+        // System.out.println("ElementInterface schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
@@ -203,19 +202,19 @@ public void class_is_referenced_twice_in_hierarchy_test() throws JsonMappingExce
             @JsonSubTypes.Type(value = Png.class),
     })
     @AvroNamespace(TEST_NAMESPACE) // @AvroNamespace makes it easier to create schema string representation
-    private static class Image {
+    static class Image {
     }
 
     private static final String IMAGE_ITSELF_SCHEMA_STR = "{\"type\":\"record\",\"name\":\"Image\",\"namespace\":\"test\",\"fields\":[]}";
 
-    private static class Jpeg extends Image {
+    static class Jpeg extends Image {
     }
 
-    private static class Png extends Image {
+    static class Png extends Image {
     }
 
     @Test
-    public void base_class_explicitly_in_JsonSubTypes_annotation_test() throws IOException {
+    public void base_class_explicitly_in_JsonSubTypes_annotation_test() throws Exception {
         // GIVEN
         final Schema imageItselfSchema = MAPPER.schemaFrom(IMAGE_ITSELF_SCHEMA_STR).getAvroSchema();
         final Schema jpegSchema = MAPPER.schemaFor(Jpeg.class).getAvroSchema();
@@ -224,7 +223,7 @@ public void base_class_explicitly_in_JsonSubTypes_annotation_test() throws IOExc
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(Image.class).getAvroSchema();
 
-        System.out.println("Image schema:\n" + actualSchema.toString(true));
+        // System.out.println("Image schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
@@ -236,19 +235,19 @@ public void base_class_explicitly_in_JsonSubTypes_annotation_test() throws IOExc
             Sport.class,
             Football.class, Basketball.class})
     @AvroNamespace(TEST_NAMESPACE) // @AvroNamespace makes it easier to create schema string representation
-    private static class Sport {
+    static class Sport {
     }
 
     private static final String SPORT_ITSELF_SCHEMA_STR = "{\"type\":\"record\",\"name\":\"Sport\",\"namespace\":\"test\",\"fields\":[]}";
 
-    private static class Football extends Sport {
+    static class Football extends Sport {
     }
 
-    private static class Basketball extends Sport {
+    static class Basketball extends Sport {
     }
 
     @Test
-    public void base_class_explicitly_in_Union_annotation_test() throws IOException {
+    public void base_class_explicitly_in_Union_annotation_test() throws Exception {
         // GIVEN
         final Schema sportItselfSchema = MAPPER.schemaFrom(SPORT_ITSELF_SCHEMA_STR).getAvroSchema();
         final Schema footballSchema = MAPPER.schemaFor(Football.class).getAvroSchema();
@@ -257,7 +256,7 @@ public void base_class_explicitly_in_Union_annotation_test() throws IOException
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(Sport.class).getAvroSchema();
 
-        System.out.println("Sport schema:\n" + actualSchema.toString(true));
+        //System.out.println("Sport schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
@@ -268,29 +267,28 @@ public void base_class_explicitly_in_Union_annotation_test() throws IOException
             // Interface being explicitly in @Union led to StackOverflowError exception.
             DocumentInterface.class,
             Word.class, Excel.class})
-    private interface DocumentInterface {
+    interface DocumentInterface {
     }
 
-    private static class Word implements DocumentInterface {
+    static class Word implements DocumentInterface {
     }
 
-    private static class Excel implements DocumentInterface {
+    static class Excel implements DocumentInterface {
     }
 
     @Test
-    public void interface_explicitly_in_Union_annotation_test() throws IOException {
+    public void interface_explicitly_in_Union_annotation_test() throws Exception {
         // GIVEN
         final Schema wordSchema = MAPPER.schemaFor(Word.class).getAvroSchema();
         final Schema excelSchema = MAPPER.schemaFor(Excel.class).getAvroSchema();
 
         // WHEN
         Schema actualSchema = MAPPER.schemaFor(DocumentInterface.class).getAvroSchema();
 
-        System.out.println("Document schema:\n" + actualSchema.toString(true));
+        //System.out.println("Document schema:\n" + actualSchema.toString(true));
 
         // THEN
         assertThat(actualSchema.getType()).isEqualTo(Schema.Type.UNION);
         assertThat(actualSchema.getTypes()).containsExactlyInAnyOrder(wordSchema, excelSchema);
     }
-
 }