Fix #4818: rename AnnotationIntrospector.findDefaultCreator() as findPreferredCreator (#4819)

Author: cowtowncoder

release-notes/VERSION

@@ -73,6 +73,7 @@ Versions: 3.x (for earlier see VERSION-2.x)
 #4659: Remove use of global static `TypeFactory` singleton from 3.0
 #4664: Change `EnumNamingStrategy.convertEnumToExternalName()` to take `MapperConfig` argument-
  (contributed by Joo-Hyuk K)
+#4818: Rename `AnnotationIntrospector.findDefaultCreator()` as `findPreferredCreator()`
 - Remove `MappingJsonFactory`
 - Add context parameter for `TypeSerializer` contextualization (`forProperty()`)
 - Default for `JsonNodeFeature.STRIP_TRAILING_BIGDECIMAL_ZEROES` changed to `false` for 3.0

src/main/java/tools/jackson/databind/AnnotationIntrospector.java

@@ -1153,14 +1153,14 @@ public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated
 
     /**
      * Method called to check if introspector can find a Creator it considers
-     * the "Primary Creator": Creator to use as the primary one, when no Creator has
+     * its "Preferred Creator": Creator to use as the primary one, when no Creator has
      * explicit annotation ({@link #findCreatorAnnotation} returns {@code null}).
-     * Examples of default creators include the canonical constructor defined by
+     * Examples of preferred creators include the canonical constructor defined by
      * Java Records; "Data" classes by frameworks
      * like Lombok and JVM languages like Kotlin and Scala (case classes) also have
      * similar concepts.
      * If introspector can determine that one of given {@link PotentialCreator}s should
-     * be considered the primary, it should return it; if not, should return {@code null}.
+     * be considered preferred one, it should return it; if not, it should return {@code null}.
      * Note that core databind functionality may call this method even in the presence of
      * explicitly annotated creators; and may or may not use Creator returned depending
      * on other criteria.
@@ -1171,10 +1171,8 @@ public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated
      * NOTE: method is NOT called for Java Record types; selection of the canonical constructor
      * as the Primary creator is handled directly by {@link POJOPropertiesCollector}
      *<p>
-     * NOTE: naming of this method is unfortunately inconsistent in that "default Creator"
-     * has other meanings than "primary Creator" -- in other places Jackson code
-     * refers to no-arguments Constructors as "default Creators". So this method
-     * ought to have been named {@code findPrimaryCreator()}.
+     * NOTE: was called {@code findDefaultCreator()} in Jackson 2.x but was renamed
+     * due to possible confusion with 0-argument "default" constructor.
      *
      * @param config Configuration settings in effect (for deserialization)
      * @param valueClass Class being instantiated; defines Creators passed
@@ -1186,7 +1184,7 @@ public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated
      *
      * @since 2.18
      */
-    public PotentialCreator findDefaultCreator(MapperConfig<?> config,
+    public PotentialCreator findPreferredCreator(MapperConfig<?> config,
             AnnotatedClass valueClass,
             List<PotentialCreator> declaredConstructors,
             List<PotentialCreator> declaredFactories) {

src/main/java/tools/jackson/databind/introspect/AnnotationIntrospectorPair.java

@@ -665,14 +665,14 @@ public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated
     }
 
     @Override
-    public PotentialCreator findDefaultCreator(MapperConfig<?> config,
+    public PotentialCreator findPreferredCreator(MapperConfig<?> config,
             AnnotatedClass valueClass,
             List<PotentialCreator> declaredConstructors,
             List<PotentialCreator> declaredFactories) {
-        PotentialCreator primaryCtor = _primary.findDefaultCreator(config,
+        PotentialCreator primaryCtor = _primary.findPreferredCreator(config,
                 valueClass, declaredConstructors, declaredFactories);
         if (primaryCtor == null) {
-            primaryCtor = _secondary.findDefaultCreator(config,
+            primaryCtor = _secondary.findPreferredCreator(config,
                     valueClass, declaredConstructors, declaredFactories);
         }
         return primaryCtor;

src/main/java/tools/jackson/databind/introspect/POJOPropertiesCollector.java

@@ -610,7 +610,7 @@ protected void _addCreators(Map<String, POJOPropertyBuilder> props)
             // 02-Nov-2024, tatu: Alas, naming here is confusing: method properly
             //    should have been "findPrimaryCreator()" so as not to confused with
             //    0-args default Creators...
-            primaryCreator = _annotationIntrospector.findDefaultCreator(_config, _classDef,
+            primaryCreator = _annotationIntrospector.findPreferredCreator(_config, _classDef,
                     constructors, factories);
         }
         // Next: remove creators marked as explicitly disabled

src/test/java/tools/jackson/databind/introspect/DefaultCreatorDetection4584Test.java

@@ -114,7 +114,7 @@ public PrimaryCreatorFindingIntrospector(JsonCreator.Mode mode,
         }
 
         @Override
-        public PotentialCreator findDefaultCreator(MapperConfig<?> config,
+        public PotentialCreator findPreferredCreator(MapperConfig<?> config,
                 AnnotatedClass valueClass,
                 List<PotentialCreator> declaredConstructors,
                 List<PotentialCreator> declaredFactories)

src/test/java/tools/jackson/databind/introspect/DefaultCreatorResolution4620Test.java

@@ -48,7 +48,7 @@ public PrimaryConstructorFindingIntrospector(Class<?>... argTypes) {
         }
 
         @Override
-        public PotentialCreator findDefaultCreator(MapperConfig<?> config,
+        public PotentialCreator findPreferredCreator(MapperConfig<?> config,
                 AnnotatedClass valueClass,
                 List<PotentialCreator> declaredConstructors,
                 List<PotentialCreator> declaredFactories)