Merge branch '2.11'

cowtowncoder · cowtowncoder · commit d77b5cdfef9f · 2019-12-27T12:12:43.000-08:00
diff --git a/src/main/java/com/fasterxml/jackson/databind/AnnotationIntrospector.java b/src/main/java/com/fasterxml/jackson/databind/AnnotationIntrospector.java
@@ -503,6 +503,40 @@ public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config,
         return null;
     }
 
+    /**
+     * Method called on fields that are eligible candidates for properties
+     * (that is, non-static member fields), but not necessarily selected (may
+     * or may not be visible), to let fields affect name linking.
+     * Call will be made after finding implicit name (which by default is just
+     * name of the field, but may be overridden by introspector), but before
+     * discovering other accessors.
+     * If non-null name returned, it is to be used to find other accessors (getters,
+     * setters, creator parameters) and replace their implicit names with that
+     * of field's implicit name (assuming they differ).
+     *<p>
+     * Specific example (and initial use case is for support Kotlin's "is getter"
+     * matching (see
+     * <a href="https://kotlinlang.org/docs/reference/java-to-kotlin-interop.html">Kotling Interop</a>
+     * for details), in which field like '{@code isOpen}' would have implicit name of
+     * "isOpen", match getter {@code getOpen()} and setter {@code setOpen(boolean)},
+     * but use logical external name of "isOpen" (and not implicit name of getter/setter, "open"!).
+     * To achieve this, field implicit name needs to remain "isOpen" but this method needs
+     * to return name {@code PropertyName.construct("open")}: doing so will "pull in" getter
+     * and/or setter, and rename them as "isOpen".
+     *
+     * @param config Effective mapper configuration in use
+     * @param f Field to check
+     * @param implName Implicit name of the field; usually name of field itself but not always,
+     *    used as the target name for accessors to rename.
+     *
+     * @return Name used to find other accessors to rename, if any; {@code null} to indicate
+     *    no renaming
+     */
+    public PropertyName findRenameByField(MapperConfig<?> config,
+            AnnotatedField f, PropertyName implName) {
+        return null;
+    }
+
     /*
     /**********************************************************************
     /* Serialization: general annotations
diff --git a/src/main/java/com/fasterxml/jackson/databind/introspect/AnnotationIntrospectorPair.java b/src/main/java/com/fasterxml/jackson/databind/introspect/AnnotationIntrospectorPair.java
@@ -474,6 +474,16 @@ public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config,
         return res;
     }
 
+    @Override // since 2.11
+    public PropertyName findRenameByField(MapperConfig<?> config,
+            AnnotatedField f, PropertyName implName) {
+        PropertyName n = _secondary.findRenameByField(config, f, implName);
+        if (n == null) {
+            n = _primary.findRenameByField(config, f, implName);
+        }
+        return n;
+    }
+
     // // // Serialization: type refinements
 
     @Override
diff --git a/src/main/java/com/fasterxml/jackson/databind/introspect/JacksonAnnotationIntrospector.java b/src/main/java/com/fasterxml/jackson/databind/introspect/JacksonAnnotationIntrospector.java
@@ -536,6 +536,13 @@ public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config,
         return null;
     }
 
+    @Override // since 2.11
+    public PropertyName findRenameByField(MapperConfig<?> config,
+            AnnotatedField f, PropertyName implName) {
+        // Nothing to report, only used by modules. But define just as documentation
+        return null;
+    }
+    
     /*
     /**********************************************************************
     /* Annotations for Polymorphic Type handling
diff --git a/src/main/java/com/fasterxml/jackson/databind/introspect/POJOPropertiesCollector.java b/src/main/java/com/fasterxml/jackson/databind/introspect/POJOPropertiesCollector.java
@@ -21,9 +21,9 @@
 public class POJOPropertiesCollector
 {
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Configuration
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -58,11 +58,11 @@ public class POJOPropertiesCollector
      * but differs for builder objects ("with" by default).
      */
     protected final String _mutatorPrefix;
-    
+
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Collected property information
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -106,11 +106,11 @@ public class POJOPropertiesCollector
      * value injection.
      */
     protected LinkedHashMap<Object, AnnotatedMember> _injectables;
-    
+
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Life-cycle
-    /**********************************************************
+    /**********************************************************************
      */
 
     protected POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization,
@@ -133,9 +133,9 @@ protected POJOPropertiesCollector(MapperConfig<?> config, boolean forSerializati
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Public API
-    /**********************************************************
+    /**********************************************************************
      */
 
     public MapperConfig<?> getConfig() {
@@ -267,9 +267,9 @@ protected Map<String, POJOPropertyBuilder> getPropertyMap() {
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Public API: main-level collection
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -289,6 +289,9 @@ protected void collectAll()
         }
         _addInjectables(props);
 
+        // 27-Dec-2019, tatu: [databind#2527] initial re-linking by Field needs to
+        //    be applied before other processing
+        
         // Remove ignored properties, first; this MUST precede annotation merging
         // since logic relies on knowing exactly which accessor has which annotation
         _removeUnwantedProperties(props);
@@ -326,9 +329,9 @@ protected void collectAll()
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Overridable internal methods, adding members
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -343,7 +346,7 @@ protected void _addFields(Map<String, POJOPropertyBuilder> props)
          */
         final boolean pruneFinalFields = !_forSerialization && !_config.isEnabled(MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS);
         final boolean transientAsIgnoral = _config.isEnabled(MapperFeature.PROPAGATE_TRANSIENT_MARKER);
-        
+
         for (AnnotatedField f : _classDef.fields()) {
             // @JsonValue?
             if (Boolean.TRUE.equals(ai.hasAsValue(_config, f))) {
@@ -356,7 +359,7 @@ protected void _addFields(Map<String, POJOPropertyBuilder> props)
             // @JsonAnySetter?
             if (Boolean.TRUE.equals(ai.hasAnySetter(_config, f))) {
                 if (_anySetterField == null) {
-                    _anySetterField = new LinkedList<AnnotatedMember>();
+                    _anySetterField = new LinkedList<>();
                 }
                 _anySetterField.add(f);
                 continue;
@@ -365,14 +368,22 @@ protected void _addFields(Map<String, POJOPropertyBuilder> props)
             if (implName == null) {
                 implName = f.getName();
             }
+
+            // [databind#2527: Field-based renaming can be applied early (here),
+            // or at a later point, but probably must be done before pruning
+            // final fields. So let's do it early here
+            final PropertyName rename = ai.findRenameByField(_config, f, _propNameFromSimple(implName));
+            if (rename != null) {
+                // todo
+            }
+            
             PropertyName pn;
 
             if (_forSerialization) {
-                /* 18-Aug-2011, tatu: As per existing unit tests, we should only
-                 *   use serialization annotation (@JsonSerialize) when serializing
-                 *   fields, and similarly for deserialize-only annotations... so
-                 *   no fallbacks in this particular case.
-                 */
+                // 18-Aug-2011, tatu: As per existing unit tests, we should only
+                //   use serialization annotation (@JsonSerialize) when serializing
+                //   fields, and similarly for deserialize-only annotations... so
+                //   no fallbacks in this particular case.
                 pn = ai.findNameForSerialization(_config, f);
             } else {
                 pn = ai.findNameForDeserialization(_config, f);
@@ -405,7 +416,7 @@ protected void _addFields(Map<String, POJOPropertyBuilder> props)
             }
             /* [databind#190]: this is the place to prune final fields, if they are not
              *  to be used as mutators. Must verify they are not explicitly included.
-             *  Also: if 'ignored' is set, need to included until a later point, to
+             *  Also: if 'ignored' is set, need to include until a later point, to
              *  avoid losing ignoral information.
              */
             if (pruneFinalFields && (pn == null) && !ignored
@@ -427,15 +438,15 @@ protected void _addCreators(Map<String, POJOPropertyBuilder> props)
         }
         for (AnnotatedConstructor ctor : _classDef.getConstructors()) {
             if (_creatorProperties == null) {
-                _creatorProperties = new LinkedList<POJOPropertyBuilder>();
+                _creatorProperties = new LinkedList<>();
             }
             for (int i = 0, len = ctor.getParameterCount(); i < len; ++i) {
                 _addCreatorParam(props, ctor.getParameter(i));
             }
         }
         for (AnnotatedMethod factory : _classDef.getFactoryMethods()) {
             if (_creatorProperties == null) {
-                _creatorProperties = new LinkedList<POJOPropertyBuilder>();
+                _creatorProperties = new LinkedList<>();
             }
             for (int i = 0, len = factory.getParameterCount(); i < len; ++i) {
                 _addCreatorParam(props, factory.getParameter(i));
@@ -654,11 +665,11 @@ protected void _doAddInjectable(JacksonInject.Value injectable, AnnotatedMember
     private PropertyName _propNameFromSimple(String simpleName) {
         return PropertyName.construct(simpleName, null);
     }
-    
+
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Internal methods; removing ignored properties
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -729,9 +740,9 @@ private void _collectIgnorals(String name)
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Internal methods; renaming properties
-    /**********************************************************
+    /**********************************************************************
      */
 
     protected void _renameProperties(Map<String, POJOPropertyBuilder> props)
@@ -893,9 +904,9 @@ protected void _renameWithWrappers(Map<String, POJOPropertyBuilder> props)
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Overridable internal methods, sorting, other stuff
-    /**********************************************************
+    /**********************************************************************
      */
 
     // First, order by(explicit ordering and/or alphabetic),
@@ -1014,9 +1025,9 @@ private boolean _anyIndexed(Collection<POJOPropertyBuilder> props) {
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Internal methods; helpers
-    /**********************************************************
+    /**********************************************************************
      */
 
     protected void reportProblem(String msg, Object... args) {
diff --git a/src/main/java/com/fasterxml/jackson/databind/util/BeanUtil.java b/src/main/java/com/fasterxml/jackson/databind/util/BeanUtil.java
@@ -174,7 +174,7 @@ protected static boolean isGroovyMetaClassGetter(AnnotatedMember am) {
     // 24-Sep-2017, tatu: note that "std" here refers to earlier (1.x, 2.x) distinction
     //   between "legacy" (slightly non-conforming) and "std" (fully conforming): with 3.x
     //   only latter exists.
-    protected static String stdManglePropertyName(final String basename, final int offset)
+    public static String stdManglePropertyName(final String basename, final int offset)
     {
         final int end = basename.length();
         if (end == offset) { // empty name, nope
diff --git a/src/test/java/com/fasterxml/jackson/failing/IsGetterRenaming2527Test.java b/src/test/java/com/fasterxml/jackson/failing/IsGetterRenaming2527Test.java
@@ -0,0 +1,85 @@
+package com.fasterxml.jackson.failing;
+
+import java.util.Collections;
+import java.util.Map;
+
+import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.cfg.MapperConfig;
+import com.fasterxml.jackson.databind.introspect.AnnotatedField;
+import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;
+import com.fasterxml.jackson.databind.util.BeanUtil;
+
+// [databind#2527] Support Kotlin-style "is" properties
+public class IsGetterRenaming2527Test extends BaseMapTest
+{
+    static class POJO2527 {
+        private boolean isEnabled;
+
+        protected POJO2527() { }
+        public POJO2527(boolean b) {
+            isEnabled = b;
+        }
+
+        public boolean getEnabled() { return isEnabled; }
+        public void setEnabled(boolean b) { isEnabled = b; }
+    }
+
+    static class POJO2527b {
+        public boolean isEnabled;
+
+        protected POJO2527b() { }
+        public POJO2527b(boolean b) {
+            isEnabled = b;
+        }
+
+        public boolean getEnabled() { return isEnabled; }
+        public void setEnabled(boolean b) { isEnabled = b; }
+    }
+    
+    @SuppressWarnings("serial")
+    static class MyIntrospector extends JacksonAnnotationIntrospector
+    {
+        @Override
+        public PropertyName findRenameByField(MapperConfig<?> config,
+                AnnotatedField f, PropertyName implName)
+        {
+            final String origSimple = implName.getSimpleName();
+            if (origSimple.startsWith("is")) {
+                String mangledName = BeanUtil.stdManglePropertyName(origSimple, 2);
+                // Needs to be valid ("is" -> null), and different from original
+                if ((mangledName != null) && !mangledName.equals(origSimple)) {
+                    return PropertyName.construct(mangledName);
+                }
+            }
+            return null;
+        }
+    }
+    
+    private final ObjectMapper MAPPER = newJsonMapper();
+
+    public void testIsPropertiesStdKotlin() throws Exception
+    {
+        POJO2527 input = new POJO2527(true);
+        final String json = MAPPER.writeValueAsString(input);
+
+        Map<?, ?> props = MAPPER.readValue(json, Map.class);
+        assertEquals(Collections.singletonMap("isEnabled", Boolean.TRUE),
+                props);
+        
+        POJO2527 output = MAPPER.readValue(json, POJO2527.class);
+        assertEquals(input.isEnabled, output.isEnabled);
+    }
+
+    public void testIsPropertiesAlt() throws Exception
+    {
+        POJO2527b input = new POJO2527b(true);
+        final String json = MAPPER.writeValueAsString(input);
+
+        Map<?, ?> props = MAPPER.readValue(json, Map.class);
+        assertEquals(Collections.singletonMap("isEnabled", Boolean.TRUE),
+                props);
+        
+        POJO2527b output = MAPPER.readValue(json, POJO2527b.class);
+        assertEquals(input.isEnabled, output.isEnabled);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ protected static boolean isGroovyMetaClassGetter(AnnotatedMember am) {`
`174`	`174`	`// 24-Sep-2017, tatu: note that "std" here refers to earlier (1.x, 2.x) distinction`
`175`	`175`	`// between "legacy" (slightly non-conforming) and "std" (fully conforming): with 3.x`
`176`	`176`	`// only latter exists.`
`177`		`- protected static String stdManglePropertyName(final String basename, final int offset)`
	`177`	`+ public static String stdManglePropertyName(final String basename, final int offset)`
`178`	`178`	`{`
`179`	`179`	`final int end = basename.length();`
`180`	`180`	`if (end == offset) { // empty name, nope`