Add release notes wrt #715

FasterXML · Jan 3, 2022 · cfb8d27 · cfb8d27
1 parent 8bed4d8
commit cfb8d27
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 13 deletions.
diff --git a/release-notes/CREDITS-2.x b/release-notes/CREDITS-2.x
@@ -282,3 +282,7 @@ Andrey Somov (asomov@github)
 Ilya Golovin (ilgo0413@github)
   * Contributed #684: Add "JsonPointer#appendProperty" and "JsonPointer#appendIndex"
   (2.14.0)
+
+Nik Everett (nik9000@github)
+  * Contributed  #715: Allow TokenFilters to keep empty arrays and objects
+  (2.14.0)
diff --git a/release-notes/VERSION-2.x b/release-notes/VERSION-2.x
@@ -18,6 +18,8 @@ JSON library.
 
 #684: Add "JsonPointer#appendProperty" and "JsonPointer#appendIndex"
  (contributed by Ilya G)
+#715: Allow TokenFilters to keep empty arrays and objects
+ (contributed by Nik E)
 
 2.13.2 (not yet released)
 

diff --git a/src/main/java/com/fasterxml/jackson/core/filter/TokenFilter.java b/src/main/java/com/fasterxml/jackson/core/filter/TokenFilter.java
@@ -15,7 +15,6 @@
  */
 public class TokenFilter
 {
-
     /**
      * Enumeration that controls how TokenFilter return values are interpreted.
      *
@@ -58,9 +57,9 @@ public enum Inclusion {
     protected TokenFilter() { }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* API, structured values
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -134,9 +133,9 @@ public void filterFinishObject() { }
     public void filterFinishArray() { }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* API, properties/elements
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -224,9 +223,9 @@ public TokenFilter includeRootValue(int index) {
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* API, scalar values (being read)
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -249,9 +248,9 @@ public boolean includeValue(JsonParser p) throws IOException {
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* API, scalar values (being written)
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**
@@ -432,18 +431,40 @@ public boolean includeEmbeddedValue(Object value) {
         return _includeScalar();
     }
 
+    /**
+     * Call made to verify whether leaf-level empty Array value
+     * should be included in output or not.
+     *
+     * @param contentsFiltered True if Array had contents but they were
+     *   filtered out (NOT included); false if we had actual empty Array.
+     *
+     * @return True if value is to be included; false if not
+     *
+     * @since 2.14
+     */
     public boolean includeEmptyArray(boolean contentsFiltered) {
         return false;
     }
 
+    /**
+     * Call made to verify whether leaf-level empty Object value
+     * should be included in output or not.
+     *
+     * @param contentsFiltered True if Object had contents but they were
+     *   filtered out (NOT included); false if we had actual empty Object.
+     *
+     * @return True if value is to be included; false if not
+     *
+     * @since 2.14
+     */
     public boolean includeEmptyObject(boolean contentsFiltered) {
         return false;
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Overrides
-    /**********************************************************
+    /**********************************************************************
      */
 
     @Override
@@ -455,9 +476,9 @@ public String toString() {
     }
 
     /*
-    /**********************************************************
+    /**********************************************************************
     /* Other methods
-    /**********************************************************
+    /**********************************************************************
      */
 
     /**