Initial #888 implementation, minus tests, probably not fully working yet

Author: cowtowncoder

pom.xml

@@ -48,6 +48,8 @@
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-annotations</artifactId>
+      <!-- temporarily, until updating parent -->
+      <version>2.9.0-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>

release-notes/VERSION

@@ -6,7 +6,7 @@ Project: jackson-databind
 
 2.9.0 (not yet released)
 
-#1341: FAIL_ON_MISSING_EXTERNAL_TYPE_ID_PROPERTY
+#1341: `DeserializationFeature.FAIL_ON_MISSING_EXTERNAL_TYPE_ID_PROPERTY`
  (contributed by Connor K)
 #1356: Differentiate between input and code exceptions on deserialization
  (suggested by Nick B)

src/main/java/com/fasterxml/jackson/databind/JsonSerializer.java

@@ -157,7 +157,7 @@ public void serializeWithType(T value, JsonGenerator gen, SerializerProvider ser
         if (clz == null) {
             clz = value.getClass();
         }
-        serializers.reportDefinitionProblem(clz, String.format(
+        serializers.reportBadDefinition(clz, String.format(
                 "Type id handling not implemented for type %s (by serializer of type %s)",
                 clz.getName(), getClass().getName()));
     }

src/main/java/com/fasterxml/jackson/databind/SerializerProvider.java

@@ -925,6 +925,17 @@ public abstract JsonSerializer<Object> serializerInstance(Annotated annotated,
             Object serDef)
         throws JsonMappingException;
 
+    /**
+     * Method that can be called to construct and configure {@link JsonInclude}
+     * filter instance,
+     * given a {@link Class} to instantiate (with default constructor, by default).
+     *
+     * @since 2.9
+     */
+    public abstract Object includeFilterInstance(BeanPropertyDefinition forProperty,
+            Class<?> filterClass)
+        throws JsonMappingException;
+
     /*
     /**********************************************************
     /* Support for contextualization
@@ -1156,10 +1167,20 @@ public <T> T reportBadDefinition(JavaType type, String msg) throws JsonMappingEx
      *
      * @since 2.9
      */
-    public <T> T reportDefinitionProblem(Class<?> type, String msg) throws JsonMappingException {
+    public <T> T reportBadDefinition(Class<?> type, String msg) throws JsonMappingException {
         throw InvalidDefinitionException.from(getGenerator(), msg, constructType(type));
     }
 
+    /**
+     * @since 2.9
+     */
+    public <T> T reportBadDefinition(JavaType type, String msg, Throwable cause)
+            throws JsonMappingException {
+        InvalidDefinitionException e = InvalidDefinitionException.from(getGenerator(), msg, type);
+        e.initCause(cause);
+        throw e;
+    }
+    
     /**
      * Helper method called to indicate problem; default behavior is to construct and
      * throw a {@link JsonMappingException}, but in future may collect more than one

src/main/java/com/fasterxml/jackson/databind/cfg/HandlerInstantiator.java

@@ -5,6 +5,7 @@
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.deser.ValueInstantiator;
 import com.fasterxml.jackson.databind.introspect.Annotated;
+import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
 import com.fasterxml.jackson.databind.jsontype.TypeIdResolver;
 import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
 import com.fasterxml.jackson.databind.ser.VirtualBeanPropertyWriter;
@@ -160,4 +161,22 @@ public VirtualBeanPropertyWriter virtualPropertyWriterInstance(MapperConfig<?> c
             Class<?> implClass) {
         return null;
     }
+
+    /**
+     * Method called to construct a Filter (any Object with implementation of
+     * <code>equals(Object)</code> that determines if given value is to be
+     * excluded (true) or included (false)) to be used based on
+     * {@link com.fasterxml.jackson.annotation.JsonInclude} annotation (or
+     * equivalent).
+     *<p> 
+     * Default implementation returns `null` to indicate that default instantiation
+     * (use zero-arg constructor of the <code>filterClass</code>) should be
+     * used.
+     *
+     * @since 2.9
+     */
+    public Object includeFilterInstance(SerializationConfig config,
+            BeanPropertyDefinition forProperty, Class<?> filterClass) {
+        return null;
+    }
 }

src/main/java/com/fasterxml/jackson/databind/ser/DefaultSerializerProvider.java

@@ -9,6 +9,7 @@
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.cfg.HandlerInstantiator;
 import com.fasterxml.jackson.databind.introspect.Annotated;
+import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
 import com.fasterxml.jackson.databind.jsonschema.SchemaAware;
 import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
@@ -100,7 +101,8 @@ public DefaultSerializerProvider copy() {
      */
 
     @Override
-    public JsonSerializer<Object> serializerInstance(Annotated annotated, Object serDef) throws JsonMappingException
+    public JsonSerializer<Object> serializerInstance(Annotated annotated, Object serDef)
+            throws JsonMappingException
     {
         if (serDef == null) {
             return null;
@@ -110,11 +112,11 @@ public JsonSerializer<Object> serializerInstance(Annotated annotated, Object ser
         if (serDef instanceof JsonSerializer) {
             ser = (JsonSerializer<?>) serDef;
         } else {
-            /* Alas, there's no way to force return type of "either class
-             * X or Y" -- need to throw an exception after the fact
-             */
+            // Alas, there's no way to force return type of "either class
+            // X or Y" -- need to throw an exception after the fact
             if (!(serDef instanceof Class)) {
-                throw new IllegalStateException("AnnotationIntrospector returned serializer definition of type "
+                reportBadDefinition(annotated.getType(),
+                        "AnnotationIntrospector returned serializer definition of type "
                         +serDef.getClass().getName()+"; expected type JsonSerializer or Class<JsonSerializer> instead");
             }
             Class<?> serClass = (Class<?>)serDef;
@@ -123,7 +125,8 @@ public JsonSerializer<Object> serializerInstance(Annotated annotated, Object ser
                 return null;
             }
             if (!JsonSerializer.class.isAssignableFrom(serClass)) {
-                throw new IllegalStateException("AnnotationIntrospector returned Class "
+                reportBadDefinition(annotated.getType(),
+                        "AnnotationIntrospector returned Class "
                         +serClass.getName()+"; expected Class<JsonSerializer>");
             }
             HandlerInstantiator hi = _config.getHandlerInstantiator();
@@ -136,6 +139,22 @@ public JsonSerializer<Object> serializerInstance(Annotated annotated, Object ser
         return (JsonSerializer<Object>) _handleResolvable(ser);
     }
 
+    @Override
+    public Object includeFilterInstance(BeanPropertyDefinition forProperty,
+            Class<?> filterClass)
+    {
+        if (filterClass == null) {
+            return null;
+        }
+        HandlerInstantiator hi = _config.getHandlerInstantiator();
+        Object filter = (hi == null) ? null : hi.includeFilterInstance(_config, forProperty, filterClass);
+        if (filter == null) {
+            filter = (JsonSerializer<?>) ClassUtil.createInstance(filterClass,
+                    _config.canOverrideAccessModifiers());
+        }
+        return filter;
+    }
+
     /*
     /**********************************************************
     /* Object Id handling

src/main/java/com/fasterxml/jackson/databind/ser/PropertyBuilder.java

@@ -184,12 +184,28 @@ protected BeanPropertyWriter buildWriter(SerializerProvider prov,
             // but possibly also 'empty' values:
             valueToSuppress = BeanPropertyWriter.MARKER_FOR_EMPTY;
             break;
+        case CUSTOM: // new with 2.9
+            valueToSuppress = prov.includeFilterInstance(propDef, inclV.getValueFilter());
+            if (valueToSuppress == null) { // is this legal?
+                suppressNulls = true;
+            } else {
+                // should let filter decide what to do with nulls:
+                // But just case, let's handle unexpected (from our perspective) problems explicitly
+                try {
+                    suppressNulls = valueToSuppress.equals(null);
+                } catch (Throwable t) {
+                    prov.reportBadDefinition(_beanDesc.getType(),
+                            "Problem determining whether `null` values are to be suppressed: "+t.getMessage(),
+                            t);
+                }
+            }
+            break;
         case NON_NULL:
             suppressNulls = true;
             // fall through
         case ALWAYS: // default
         default:
-            // we may still want to suppress empty collections, as per [JACKSON-254]:
+            // we may still want to suppress empty collections
             if (actualType.isContainerType()
                     && !_config.isEnabled(SerializationFeature.WRITE_EMPTY_JSON_ARRAYS)) {
                 valueToSuppress = BeanPropertyWriter.MARKER_FOR_EMPTY;

src/main/java/com/fasterxml/jackson/databind/ser/impl/UnknownSerializer.java

@@ -66,7 +66,7 @@ public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType t
 
     protected void failForEmpty(SerializerProvider prov, Object value)
             throws JsonMappingException {
-        prov.reportDefinitionProblem(handledType(), String.format(
+        prov.reportBadDefinition(handledType(), String.format(
                 "No serializer found for class %s and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)",
                 value.getClass().getName()));
     }

src/main/java/com/fasterxml/jackson/databind/ser/impl/UnwrappingBeanSerializer.java

@@ -126,7 +126,7 @@ public void serializeWithType(Object bean, JsonGenerator gen, SerializerProvider
     		TypeSerializer typeSer) throws IOException
     {
         if (provider.isEnabled(SerializationFeature.FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS)) {
-            provider.reportDefinitionProblem(handledType(),
+            provider.reportBadDefinition(handledType(),
                     "Unwrapped property requires use of type information: can not serialize without disabling `SerializationFeature.FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS`");
         }
         gen.setCurrentValue(bean); // [databind#631]

src/main/java/com/fasterxml/jackson/databind/ser/std/StdSerializer.java

@@ -438,7 +438,7 @@ protected PropertyFilter findPropertyFilter(SerializerProvider provider,
         FilterProvider filters = provider.getFilterProvider();
         // Not ok to miss the provider, if a filter is declared to be needed.
         if (filters == null) {
-            provider.reportDefinitionProblem(handledType(),
+            provider.reportBadDefinition(handledType(),
                     "Can not resolve PropertyFilter with id '"+filterId+"'; no FilterProvider configured");
         }
         // But whether unknown ids are ok just depends on filter provider; if we get null that's fine

src/test/java/com/fasterxml/jackson/databind/filter/JsonIncludeCustomTest.java

@@ -0,0 +1,21 @@
+package com.fasterxml.jackson.databind.filter;
+
+import com.fasterxml.jackson.databind.BaseMapTest;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+// Tests for [databind#888]
+public class JsonIncludeCustomTest extends BaseMapTest
+{
+    /*
+    /**********************************************************
+    /* Test methods
+    /**********************************************************
+     */
+
+    final private ObjectMapper MAPPER = new ObjectMapper();
+
+    public void testSimpleCustomFilter() throws Exception
+    {
+        
+    }
+}

src/test/java/com/fasterxml/jackson/databind/filter/JsonIncludeTest.java

@@ -129,7 +129,7 @@ static class EmptyListMapBean
 
     /*
     /**********************************************************
-    /* Unit tests
+    /* Test methods
     /**********************************************************
      */