com.fasterxml.jackson.datatype.jdk8

Class Jdk8Module

java.lang.Object

com.fasterxml.jackson.databind.Module

com.fasterxml.jackson.datatype.jdk8.Jdk8Module

All Implemented Interfaces:

Versioned

public class Jdk8Module
extends Module

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

Module.SetupContext

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_cfgHandleAbsentAsNull Configuration setting that determines whether `Optional.empty()` is considered "same as null" for serialization purposes; that is, to be filtered same as nulls are.

Constructor Summary

Constructors

Constructor and Description
Jdk8Module()

Method Summary

Modifier and Type	Method and Description
Jdk8Module	configureAbsentsAsNulls(boolean state) Configuration method that may be used to change configuration setting _cfgHandleAbsentAsNull: enabling means that `Optional.empty()` values are handled like Java nulls (wrt filtering on serialization); disabling that they are only treated as "empty" values, but not like native Java nulls.
boolean	equals(Object o)
String	getModuleName() Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.
int	hashCode()
void	setupModule(Module.SetupContext context) Method called by ObjectMapper when module is registered.
Version	version() Method that returns version of this module.

Methods inherited from class com.fasterxml.jackson.databind.Module

getTypeId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

_cfgHandleAbsentAsNull

protected boolean _cfgHandleAbsentAsNull

Configuration setting that determines whether `Optional.empty()` is considered "same as null" for serialization purposes; that is, to be filtered same as nulls are. If enabled, absent values are treated like nulls; if disabled, they are not. In either case, absent values are always considered "empty".

Default value is `false` for backwards compatibility (2.5 and prior only had this behavior).

Note that this setting MUST be changed BEFORE registering the module: changes after registration will have no effect.

Note that in most cases it makes more sense to just use `NON_ABSENT` inclusion criteria for filtering out absent optionals; this setting is mostly useful for legacy use cases that predate version 2.6.

Constructor Detail

Jdk8Module

public Jdk8Module()

Method Detail

setupModule

public void setupModule(Module.SetupContext context)

Description copied from class: Module

Method called by ObjectMapper when module is registered. It is called to let module register functionality it provides, using callback methods passed-in context object exposes.

Specified by:

setupModule in class Module

version

public Version version()

Description copied from class: Module

Method that returns version of this module. Can be used by Jackson for informational purposes.

Specified by:

version in interface Versioned

Specified by:

version in class Module

configureAbsentsAsNulls

public Jdk8Module configureAbsentsAsNulls(boolean state)

Configuration method that may be used to change configuration setting _cfgHandleAbsentAsNull: enabling means that `Optional.empty()` values are handled like Java nulls (wrt filtering on serialization); disabling that they are only treated as "empty" values, but not like native Java nulls. Recommended setting for this value is `false`. For compatibility with older versions of other "optional" values (like Guava optionals), it can be set to 'true'. The default is `false` for backwards compatibility.

Note that in most cases it makes more sense to just use `NON_ABSENT` inclusion criteria for filtering out absent optionals; this setting is mostly useful for legacy use cases that predate version 2.6.

Returns:

This module instance, useful for chaining calls

Since:

2.6

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getModuleName

public String getModuleName()

Description copied from class: Module

Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.

Specified by:

getModuleName in class Module