Replacement for MapperBuilder.serializationInclusion(JsonInclude.Include.NON_NULL)

[runeflobakk]

I see that MapperBuilder.serializationInclusion(JsonInclude.Include.NON_NULL) was deprecated in 2.20. I use it like this:

var jsonMapper = JsonMapper.builder().serializationInclusion(NON_NULL).build()

The javadoc advises to use MapperBuilder.defaultPropertyInclusion(JsonInclude.Value) instead, but I am not sure how to obtain an instance of JsonInclude.Value equivalent to JsonInclude.Include.NON_NULL.

I see that internally, Jackson does JsonInclude.Value.construct(incl, incl) in ObjectMapper, but is that the proper way for user code? Perhaps there is missing a defaultPropertyInclusion(JsonInclude.Include) overload in MapperBuilder? :)

[pjfanning]

I would suggest looking at test cases that use that method.

https://github.com/search?q=repo%3AFasterXML%2Fjackson-databind%20defaultPropertyInclusion&type=code

[norrisjeremy]

So do I understand correctly that the equivalent to the now deprecated:

var jsonMapper = JsonMapper.builder()
    .serializationInclusion(JsonInclude.Include.NON_NULL)
    .build();

is now this?

var jsonMapper = JsonMapper.builder()
    .defaultPropertyInclusion(JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, JsonInclude.Include.NON_NULL))
    .build();

[runeflobakk]

@norrisjeremy That is correct!

I am preparing a PR later today which intend to enable the following:

var jsonMapper = JsonMapper.builder()
    .defaultPropertyInclusion(JsonInclude.Value.ALL_NON_NULL)
    .build();

(and equivalent constants for the other enum values in JsonInclude.Include)

[norrisjeremy]

That's good to hear, & I hope it is included in a 2.20.1 release, as the existing deprecation in 2.20.0 seems premature, since the current non-deprecated form is pretty obtuse.

Also, unless I'm missing something, this new deprecation (along with the new deprecations in ObjectMapper) do not seem to be documented anywhere in the 2.20 release notes (unless I'm missing something, please correct me if I'm wrong).
It would be nice if they were documented there...

[runeflobakk]

Pull-requests:
Constants in JsonInclude.Value: FasterXML/jackson-annotations#314
A few tests adapted to use them: #5296

[cowtowncoder]

API changes cannot go in 2.20.x patches so it will be 2.21.

Release notes are indeed missing since the only change is deprecation, but I'll create placeholder issue to refer to. So that at least it is covered by release notes.

EDIT: see #5297