Feature that define global inclusion rules about which properties of a Class are to be included in serialization.
null
indicates that no global inclusion rules are defined.
Feature that determines whether properties that have no view decorators are included in JSON serialization views (see JsonView for more details on JSON Views).
If enabled, non-decorated properties will be included; when disabled, they will be excluded. So this feature changes between "opt-in" (feature disabled) and "opt-out" (feature enabled) modes.
Default value is enabled, meaning that non-decorated properties are included in all views if there is no JsonView decorator.
Feature that determines what happens when a direct self-reference is detected by a Class (and no Object Id handling is enabled for it): either a JacksonError is thrown (if true), or reference is normally processed (false).
Feature that determines whether Map
or Object Literal entries are first sorted by key before serialization or not:
if enabled, additional sorting step is performed, if disabled, no additional sorting is needed.
Feature that determines whether BigInt primitive type properties that contains null
value should
be serialized/deserialized with its default value or not.
If enabled, during serialization, the property will be serialized with its default value.
Instead, during deserialization, the null
value will be substituted with its default value.
The default BigInt value is 0n
.
Feature that determines whether Boolean primitive type properties that contains null
value should
be serialized/deserialized with its default value or not.
If enabled, during serialization, the property will be serialized with its default value.
Instead, during deserialization, the null
value will be substituted with its default value.
The default Boolean value is false
.
Feature that determines whether Number primitive type properties that contains null
value should
be serialized/deserialized with its default value or not.
If enabled, during serialization, the property will be serialized with its default value.
Instead, during deserialization, the null
value will be substituted with its default value.
The default Number value is 0
.
Feature that determines whether primitive type properties that contains null
value should
be serialized/deserialized with its default value or not.
If enabled, during serialization, the property will be serialized with its default value.
Instead, during deserialization, the null
value will be substituted with its default value.
Default values are:
0
;""
;false
;0n
;null
for all other JavaScript types.Feature that determines whether String primitive type properties that contains null
value should
be serialized/deserialized with its default value or not.
If enabled, during serialization, the property will be serialized with its default value.
Instead, during deserialization, the null
value will be substituted with its default value.
The default String value is ""
.
Feature that defines default property serialization order used for Class fields
(note: does not apply to Map
or Object Literals serialization!):
if enabled, default ordering is alphabetic
(similar to how JsonPropertyOrder with JsonPropertyOrderOptions.alphabetic works);
if disabled, order is unspecified (based on what JavaScript gives us, which may be declaration order, but is not guaranteed).
Feature that can be enabled to make root value wrapped within a single property JSON object, where key as the "root name".
Feature that determines whether Date
values are to be serialized as numeric time stamps or not.
Feature that determines whether Dates used as Map
or Object Literal keys
are serialized as time stamps or not (if not, will be serialized as textual values).
Feature that determines whether NaN
values should be serialized as 0
or not.
Feature that determines whether negative Infinity
values should be serialized as Number.MIN_SAFE_INTEGER
or not.
Feature that determines whether negative Infinity
values should be serialized as Number.MIN_VALUE
or not.
Feature that determines whether positive Infinity
values should be serialized as Number.MAX_SAFE_INTEGER
or not.
Feature that determines whether positive Infinity
values should be serialized as Number.MAX_VALUE
or not.
Feature that determines what happens when a direct self-reference is detected by
a Class (and no Object Id handling is enabled for it): if enabled write that reference as null
;
if disabled, default behavior is used (which will try to serialize usually resulting in exception).
But if FAIL_ON_SELF_REFERENCES is enabled, this property is ignored.
Generated using TypeDoc
Interface that defines features to set for ObjectMapper and JsonStringifier.
Changes only take effect when done before any serialization calls -- that is, caller must follow "configure-then-use" pattern.