Implement #522, give annotation access through PropertyWriter (similar to what BeanPropertyWriter had)

cowtowncoder · cowtowncoder · commit d1f58c6dc5ee · 2014-08-21T22:17:45.000-07:00
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java b/src/main/java/com/fasterxml/jackson/databind/ser/BeanPropertyWriter.java
@@ -320,12 +320,14 @@ public void setNonTrivialBaseType(JavaType t) {
     @Override public PropertyName getWrapperName() { return _wrapperName; }
     @Override public boolean isRequired() { return _metadata.isRequired(); }
     @Override public PropertyMetadata getMetadata() { return _metadata; }
-    
+
+    // Note: also part of 'PropertyWriter'
     @Override
     public <A extends Annotation> A getAnnotation(Class<A> acls) {
         return _member.getAnnotation(acls);
     }
 
+    // Note: also part of 'PropertyWriter'
     @Override
     public <A extends Annotation> A getContextAnnotation(Class<A> acls) {
         return _contextAnnotations.get(acls);
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/PropertyWriter.java b/src/main/java/com/fasterxml/jackson/databind/ser/PropertyWriter.java
@@ -1,7 +1,8 @@
 package com.fasterxml.jackson.databind.ser;
 
-import com.fasterxml.jackson.core.JsonGenerator;
+import java.lang.annotation.Annotation;
 
+import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor;
 import com.fasterxml.jackson.databind.node.ObjectNode;
@@ -25,7 +26,52 @@ public abstract class PropertyWriter
     public abstract String getName();
 
     public abstract PropertyName getFullName();
+
+    /**
+     * Convenience method for accessing annotation that may be associated
+     * either directly on property, or, if not, via enclosing class (context).
+     * This allows adding baseline contextual annotations, for example, by adding
+     * an annotation for a given class and making that apply to all properties
+     * unless overridden by per-property annotations.
+     *<p>
+     * This method is functionally equivalent to:
+     *<pre>
+     *  MyAnnotation ann = propWriter.getAnnotation(MyAnnotation.class);
+     *  if (ann == null) {
+     *    ann = propWriter.getContextAnnotation(MyAnnotation.class);
+     *  }
+     *</pre>
+     * that is, tries to find a property annotation first, but if one is not
+     * found, tries to find context-annotation (from enclosing class) of
+     * same type.
+     * 
+     * @since 2.5
+     */
+    public <A extends Annotation> A findAnnotation(Class<A> acls) {
+        A ann = getAnnotation(acls);
+        if (ann == null) {
+            ann = getContextAnnotation(acls);
+        }
+        return ann;
+    }
     
+    /**
+     * Method for accessing annotations directly declared for property that this
+     * writer is associated with.
+     * 
+     * @since 2.5
+     */
+    public abstract <A extends Annotation> A getAnnotation(Class<A> acls);
+
+    /**
+     * Method for accessing annotations declared in context of the property that this
+     * writer is associated with; usually this means annotations on enclosing class
+     * for property.
+     * 
+     * @since 2.5
+     */
+    public abstract <A extends Annotation> A getContextAnnotation(Class<A> acls);
+
     /*
     /**********************************************************
     /* Serialization methods, regular output
@@ -35,15 +81,15 @@ public abstract class PropertyWriter
     /**
      * The main serialization method called by filter when property is to be written normally.
      */
-    public abstract void serializeAsField(Object pojo, JsonGenerator jgen, SerializerProvider prov)
+    public abstract void serializeAsField(Object value, JsonGenerator jgen, SerializerProvider provider)
         throws Exception;
 
     /**
      * Serialization method that filter needs to call in cases where property is to be
      * filtered, but the underlying data format requires a placeholder of some kind.
      * This is usually the case for tabular (positional) data formats such as CSV.
      */
-    public abstract void serializeAsOmittedField(Object pojo, JsonGenerator jgen, SerializerProvider prov)
+    public abstract void serializeAsOmittedField(Object value, JsonGenerator jgen, SerializerProvider provider)
         throws Exception;
 
     /*
@@ -62,15 +108,15 @@ public abstract void serializeAsOmittedField(Object pojo, JsonGenerator jgen, Se
      * data format; so it is typically NOT called for fully tabular formats such as CSV,
      * where logical output is still as form of POJOs.
      */
-    public abstract void serializeAsElement(Object pojo, JsonGenerator jgen, SerializerProvider prov)
+    public abstract void serializeAsElement(Object value, JsonGenerator jgen, SerializerProvider provider)
         throws Exception;
 
     /**
      * Serialization method called when doing tabular (positional) output from databind,
      * but then value is to be omitted. This requires output of a placeholder value
      * of some sort; often similar to {@link #serializeAsOmittedField}.
      */
-    public abstract void serializeAsPlaceholder(Object pojo, JsonGenerator jgen, SerializerProvider prov)
+    public abstract void serializeAsPlaceholder(Object value, JsonGenerator jgen, SerializerProvider provider)
         throws Exception;
 
     /*
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/std/MapProperty.java b/src/main/java/com/fasterxml/jackson/databind/ser/std/MapProperty.java
@@ -1,8 +1,10 @@
 package com.fasterxml.jackson.databind.ser.std;
 
 import java.io.IOException;
+import java.lang.annotation.Annotation;
 
 import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.BeanProperty;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.PropertyName;
@@ -20,26 +22,48 @@
  */
 public class MapProperty extends PropertyWriter
 {
-    protected TypeSerializer _typeSerializer;
-    
-    protected Object _key, _value;
+    protected final TypeSerializer _typeSerializer;
+
+    protected final BeanProperty _property;
+
+    protected Object _key;
 
     protected JsonSerializer<Object> _keySerializer, _valueSerializer;
 
-    public MapProperty(TypeSerializer typeSer)
+    /**
+     * @deprecated since 2.4
+     */
+    @Deprecated // since 2.4
+    public MapProperty(TypeSerializer typeSer) {
+        this(typeSer, null);
+    }
+    
+    public MapProperty(TypeSerializer typeSer, BeanProperty prop)
     {
         _typeSerializer = typeSer;
+        _property = prop;
+    }
+
+    /**
+     * Deprecated method with wrong signature; value should not be assigned
+     * to property, should be passed via proper call-through methods.
+     * 
+     * @deprecated Since 2.5, remove in 2.6
+     */
+    @Deprecated // since 2.5
+    public void reset(Object key, Object value,
+            JsonSerializer<Object> keySer, JsonSerializer<Object> valueSer) {
+        reset(key, keySer, valueSer);
     }
     
     /**
      * Initialization method that needs to be called before passing
      * property to filter.
      */
-    public void reset(Object key, Object value,
+    public void reset(Object key,
             JsonSerializer<Object> keySer, JsonSerializer<Object> valueSer)
     {
         _key = key;
-        _value = value;
         _keySerializer = keySer;
         _valueSerializer = valueSer;
     }
@@ -58,19 +82,29 @@ public PropertyName getFullName() {
     }
 
     @Override
-    public void serializeAsField(Object pojo, JsonGenerator jgen,
+    public <A extends Annotation> A getAnnotation(Class<A> acls) {
+        return (_property == null) ? null : _property.getAnnotation(acls);
+    }
+
+    @Override
+    public <A extends Annotation> A getContextAnnotation(Class<A> acls) {
+        return (_property == null) ? null : _property.getContextAnnotation(acls);
+    }
+    
+    @Override
+    public void serializeAsField(Object value, JsonGenerator jgen,
             SerializerProvider provider) throws IOException
     {
         _keySerializer.serialize(_key, jgen, provider);
         if (_typeSerializer == null) {
-            _valueSerializer.serialize(_value, jgen, provider);
+            _valueSerializer.serialize(value, jgen, provider);
         } else {
-            _valueSerializer.serializeWithType(_value, jgen, provider, _typeSerializer);
+            _valueSerializer.serializeWithType(value, jgen, provider, _typeSerializer);
         }
     }
 
     @Override
-    public void serializeAsOmittedField(Object pojo, JsonGenerator jgen,
+    public void serializeAsOmittedField(Object value, JsonGenerator jgen,
             SerializerProvider provider) throws Exception
     {
         if (!jgen.canOmitFields()) {
@@ -79,18 +113,18 @@ public void serializeAsOmittedField(Object pojo, JsonGenerator jgen,
     }
 
     @Override
-    public void serializeAsElement(Object pojo, JsonGenerator jgen,
+    public void serializeAsElement(Object value, JsonGenerator jgen,
             SerializerProvider provider) throws Exception
     {
         if (_typeSerializer == null) {
-            _valueSerializer.serialize(_value, jgen, provider);
+            _valueSerializer.serialize(value, jgen, provider);
         } else {
-            _valueSerializer.serializeWithType(_value, jgen, provider, _typeSerializer);
+            _valueSerializer.serializeWithType(value, jgen, provider, _typeSerializer);
         }
     }
     
     @Override
-    public void serializeAsPlaceholder(Object pojo, JsonGenerator jgen,
+    public void serializeAsPlaceholder(Object value, JsonGenerator jgen,
             SerializerProvider provider) throws Exception
     {
         jgen.writeNull();
diff --git a/src/main/java/com/fasterxml/jackson/databind/ser/std/MapSerializer.java b/src/main/java/com/fasterxml/jackson/databind/ser/std/MapSerializer.java
@@ -557,7 +557,7 @@ public void serializeFilteredFields(Map<?,?> value, JsonGenerator jgen, Serializ
         final boolean skipNulls = !provider.isEnabled(SerializationFeature.WRITE_NULL_MAP_VALUES);
 
         PropertySerializerMap serializers = _dynamicValueSerializers;
-        final MapProperty prop = new MapProperty(_valueTypeSerializer);
+        final MapProperty prop = new MapProperty(_valueTypeSerializer, _property);
 
         for (Map.Entry<?,?> entry : value.entrySet()) {
             // First, serialize key
@@ -590,9 +590,9 @@ public void serializeFilteredFields(Map<?,?> value, JsonGenerator jgen, Serializ
                     serializers = _dynamicValueSerializers;
                 }
             }
-            prop.reset(keyElem, valueElem, keySer, valueSer);
+            prop.reset(keyElem, keySer, valueSer);
             try {
-                filter.serializeAsField(value, jgen, provider, prop);
+                filter.serializeAsField(valueElem, jgen, provider, prop);
             } catch (Exception e) {
                 // [JACKSON-55] Need to add reference information
                 String keyDesc = ""+keyElem;
diff --git a/src/test/java/com/fasterxml/jackson/databind/filter/TestMapFiltering.java b/src/test/java/com/fasterxml/jackson/databind/filter/TestMapFiltering.java
@@ -1,21 +1,38 @@
 package com.fasterxml.jackson.databind.filter;
 
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 import java.util.*;
 
 import com.fasterxml.jackson.annotation.JsonFilter;
+import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.ser.FilterProvider;
+import com.fasterxml.jackson.databind.ser.PropertyFilter;
+import com.fasterxml.jackson.databind.ser.PropertyWriter;
 import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
 import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
 
 public class TestMapFiltering extends BaseMapTest
 {
+    @Target({ElementType.FIELD})
+    @Retention(RetentionPolicy.RUNTIME)
+    public @interface CustomOffset
+    {
+        public int value();
+    }
+
     @SuppressWarnings("serial")
     @JsonFilter("filterForMaps")
     static class FilteredBean extends LinkedHashMap<String,Integer> { }
     
     static class MapBean {
         @JsonFilter("filterX")
+        @CustomOffset(1)
         public Map<String,Integer> values;
         
         public MapBean() {
@@ -25,7 +42,46 @@ public MapBean() {
             values.put("c", 9);
         }
     }
-    
+
+    static class MyMapFilter implements PropertyFilter
+    {
+        @Override
+        public void serializeAsField(Object value, JsonGenerator jgen,
+                SerializerProvider provider, PropertyWriter writer)
+            throws Exception
+        {
+            String name = writer.getName();
+            if (!"a".equals(name)) {
+                return;
+            }
+            CustomOffset n = writer.findAnnotation(CustomOffset.class);
+            int offset = (n == null) ? 0 : n.value();
+            Integer I = offset + ((Integer) value).intValue();
+
+            writer.serializeAsField(I, jgen, provider);
+        }
+
+        @Override
+        public void serializeAsElement(Object elementValue, JsonGenerator jgen,
+                SerializerProvider prov, PropertyWriter writer)
+                throws Exception {
+            // not needed for testing
+        }
+
+        @Override
+        public void depositSchemaProperty(PropertyWriter writer,
+                ObjectNode propertiesNode, SerializerProvider provider)
+                throws JsonMappingException {
+            
+        }
+
+        @Override
+        public void depositSchemaProperty(PropertyWriter writer,
+                JsonObjectFormatVisitor objectVisitor,
+                SerializerProvider provider) throws JsonMappingException {
+        }
+    }
+
     /*
     /**********************************************************
     /* Unit tests
@@ -53,4 +109,13 @@ public void testMapFilteringViaClass() throws Exception
         assertEquals(aposToQuotes("{'b':3}"), json);
     }
     
+    // [Issue#522]
+    public void testMapFilteringWithAnnotations() throws Exception
+    {
+        FilterProvider prov = new SimpleFilterProvider().addFilter("filterX",
+                new MyMapFilter());
+        String json = MAPPER.writer(prov).writeValueAsString(new MapBean());
+        // a=1 should become a=2
+        assertEquals(aposToQuotes("{'values':{'a':2}}"), json);
+    }
 }
