Add JsonInclude.Value convenience constants (#314)

runeflobakk · web-flow · commit 8e6d0e4fcdcd · 2025-09-08T18:00:56.000-07:00
diff --git a/release-notes/VERSION-2.x b/release-notes/VERSION-2.x
@@ -16,7 +16,8 @@ NOTE: Jackson 3.x components rely on 2.x annotations; there are no separate
 
 2.21 (not yet released)
 
-No changes since 2.20
+#314: Add `JsonInclude.Value` convenience constants
+ (contributed by @runeflobakk)
 
 2.20 (28-Aug-2025)
 
diff --git a/src/main/java/com/fasterxml/jackson/annotation/JsonInclude.java b/src/main/java/com/fasterxml/jackson/annotation/JsonInclude.java
@@ -268,6 +268,84 @@ public static class Value
     {
         private static final long serialVersionUID = 1L;
 
+        /**
+         * Constant that indicates that property is to be always included,
+         * independent of value of the property.
+         * <p>
+         * This will specify the same setting for including a value both
+         * on <b>Java object level</b> as well as when <b>contained</b>
+         * in an object reference (see {@link JsonInclude} for further
+         * details on this distinction).
+         *
+         * @since 2.21
+         */
+        public final static Value ALL_ALWAYS = Value
+                .construct(Include.ALWAYS, Include.ALWAYS);
+
+        /**
+         * Constant that indicates that only properties with non-null
+         * values are to be included.
+         * <p>
+         * This will specify the same setting for including a value both
+         * on <b>Java object level</b> as well as when <b>contained</b>
+         * in an object reference (see {@link JsonInclude} for further
+         * details on this distinction).
+         *
+         * @since 2.21
+         */
+        public final static Value ALL_NON_NULL = Value
+                .construct(Include.NON_NULL, Include.NON_NULL);
+
+        /**
+         * Constant that indicates that properties are included unless their value
+         * is:
+         * <ul>
+         *  <li>null</li>
+         *  <li>"absent" value of a referential type (like Java 8 `Optional`, or
+         *     {@link java.util.concurrent.atomic.AtomicReference}); that is, something
+         *     that would not deference to a non-null value.
+         * </ul>
+         * This option is mostly used to work with "Optional"s (Java 8, Guava).
+         * <p>
+         * This will specify the same setting for including a value both
+         * on <b>Java object level</b> as well as when <b>contained</b>
+         * in an object reference (see {@link JsonInclude} for further
+         * details on this distinction).
+         *
+         * @since 2.21
+         */
+        public final static Value ALL_NON_ABSENT = Value
+                .construct(Include.NON_ABSENT, Include.NON_ABSENT);
+
+        /**
+         * Constant that indicates that only properties with null value,
+         * or what is considered empty, are not to be included.
+         * See {@link Include#NON_EMPTY} for further details.
+         * <p>
+         * This will specify the same setting for including a value both
+         * on <b>Java object level</b> as well as when <b>contained</b>
+         * in an object reference (see {@link JsonInclude} for further
+         * details on this distinction).
+         *
+         * @since 2.21
+         */
+        public final static Value ALL_NON_EMPTY = Value
+                .construct(Include.NON_EMPTY, Include.NON_EMPTY);
+
+        /**
+         * The equivalent to {@link Include#NON_DEFAULT} for specifying
+         * inclusion of non-defaults for both values and content.
+         * <p>
+         * This will specify the same setting for including a value both
+         * on <b>Java object level</b> as well as when <b>contained</b>
+         * in an object reference (see {@link JsonInclude} for further
+         * details on this distinction).
+         *
+         * @since 2.21
+         */
+        public final static Value ALL_NON_DEFAULT = Value
+                .construct(Include.NON_DEFAULT, Include.NON_DEFAULT);
+
         protected final static Value EMPTY = new Value(Include.USE_DEFAULTS,
                 Include.USE_DEFAULTS, null, null);
 
