Skip to content

Commit ab7a5cf

Browse files
committed
Add javadoc details about value inclusion
The constants specify the same JsonInclude.Include for inclusion of values both on Java object level, as well when contained in an object reference (e.g. an AtomicReference).
1 parent 2cb264b commit ab7a5cf

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

src/main/java/com/fasterxml/jackson/annotation/JsonInclude.java

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,11 @@ public static class Value
271271
/**
272272
* Value that indicates that property is to be always included,
273273
* independent of value of the property.
274+
* <p>
275+
* This will specify the same setting for including a value both
276+
* on <b>Java object level</b> as well as when <b>contained</b>
277+
* in an object reference (see {@link JsonInclude} for further
278+
* details on this distinction)
274279
*
275280
* @since 2.21
276281
*/
@@ -280,6 +285,11 @@ public static class Value
280285
/**
281286
* Value that indicates that only properties with non-null
282287
* values are to be included.
288+
* <p>
289+
* This will specify the same setting for including a value both
290+
* on <b>Java object level</b> as well as when <b>contained</b>
291+
* in an object reference (see {@link JsonInclude} for further
292+
* details on this distinction)
283293
*
284294
* @since 2.21
285295
*/
@@ -296,6 +306,11 @@ public static class Value
296306
* that would not deference to a non-null value.
297307
* </ul>
298308
* This option is mostly used to work with "Optional"s (Java 8, Guava).
309+
* <p>
310+
* This will specify the same setting for including a value both
311+
* on <b>Java object level</b> as well as when <b>contained</b>
312+
* in an object reference (see {@link JsonInclude} for further
313+
* details on this distinction)
299314
*
300315
* @since 2.21
301316
*/
@@ -306,6 +321,11 @@ public static class Value
306321
* Value that indicates that only properties with null value,
307322
* or what is considered empty, are not to be included.
308323
* See {@link Include#NON_EMPTY} for further details.
324+
* <p>
325+
* This will specify the same setting for including a value both
326+
* on <b>Java object level</b> as well as when <b>contained</b>
327+
* in an object reference (see {@link JsonInclude} for further
328+
* details on this distinction)
309329
*
310330
* @since 2.21
311331
*/
@@ -315,6 +335,11 @@ public static class Value
315335
/**
316336
* The equivalent to {@link Include#NON_DEFAULT} for specifying
317337
* inclusion of non-defaults for both values and content.
338+
* <p>
339+
* This will specify the same setting for including a value both
340+
* on <b>Java object level</b> as well as when <b>contained</b>
341+
* in an object reference (see {@link JsonInclude} for further
342+
* details on this distinction)
318343
*
319344
* @since 2.21
320345
*/

0 commit comments

Comments
 (0)