Jackson 2.18.2 · com.fasterxml.jackson.datatype.guava.GuavaModule

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

Access	Constructor and Description
public	GuavaModule()

Method Summary

Modifier and Type	Method and Description
public GuavaModule	Returns: This module instance, useful for chaining calls configureAbsentsAsNulls(boolean state) Configuration method that may be used to change configuration setting `_cfgHandleAbsentAsNull`: enabling means that `Optional.absent()` 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.
public GuavaModule	Returns: This module instance, useful for chaining calls defaultBoundType(BoundType `BoundType` boundType) Configuration method that may be used to change the `BoundType` to be used when deserializing `com.google.common.collect.Range` objects.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getModuleName() Implements abstract com.fasterxml.jackson.databind.Module.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.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setupModule(Module.SetupContext context) Implements abstract com.fasterxml.jackson.databind.Module.setupModule. Method called by `ObjectMapper` when module is registered.
public Version	version() Implements abstract com.fasterxml.jackson.databind.Module.version. Implements com.fasterxml.jackson.core.Versioned.version. Method that returns version of this module.

Inherited from com.fasterxml.jackson.databind.Module:: getDependencies getTypeId

_cfgHandleAbsentAsNull	back to summary
protected boolean _cfgHandleAbsentAsNull Configuration setting that determines whether `Optional.absent()` 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 `true` 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.

_defaultBoundType	back to summary
protected BoundType _defaultBoundType

NAME	back to summary
private final String NAME

GuavaModule	back to summary
public GuavaModule()

Method Detail

configureAbsentsAsNulls back to summary

configureAbsentsAsNulls	back to summary
public GuavaModule configureAbsentsAsNulls(boolean state) Configuration method that may be used to change configuration setting `_cfgHandleAbsentAsNull`: enabling means that `Optional.absent()` 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 other "optional" values (like JDK 8 optionals); but the default is `true` for backwards compatibility. Returns:GuavaModule This module instance, useful for chaining calls Since 2.6

public GuavaModule configureAbsentsAsNulls(boolean state)

Configuration method that may be used to change configuration setting _cfgHandleAbsentAsNull: enabling means that `Optional.absent()` 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 other "optional" values (like JDK 8 optionals); but the default is `true` for backwards compatibility.

Returns:GuavaModule: This module instance, useful for chaining calls
Since: 2.6

defaultBoundType back to summary

defaultBoundType	back to summary
public GuavaModule defaultBoundType(BoundType boundType) Configuration method that may be used to change the `BoundType` to be used when deserializing `com.google.common.collect.Range` objects. This configuration will is used when the object to be deserialized has no bound type attribute. The default `BoundType` is CLOSED. Parameters boundType:BoundType `BoundType` Returns:GuavaModule This module instance, useful for chaining calls Since 2.7

public GuavaModule defaultBoundType(BoundType boundType)

Configuration method that may be used to change the BoundType to be used when deserializing com.google.common.collect.Range objects. This configuration will is used when the object to be deserialized has no bound type attribute. The default BoundType is CLOSED.

Parameters

boundType:BoundType: BoundType

Returns:GuavaModule

This module instance, useful for chaining calls

Since

2.7

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getModuleName	back to summary
public String getModuleName() Implements abstract com.fasterxml.jackson.databind.Module.getModuleName. Doc from com.fasterxml.jackson.databind.Module.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. Annotations @Override

getModuleName

back to summary

public String getModuleName()

Implements abstract com.fasterxml.jackson.databind.Module.getModuleName.

Doc from com.fasterxml.jackson.databind.Module.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.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

setupModule back to summary

setupModule	back to summary
public void setupModule(Module.SetupContext context) Implements abstract com.fasterxml.jackson.databind.Module.setupModule. Doc from com.fasterxml.jackson.databind.Module.setupModule. 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. Annotations @Override

public void setupModule(Module.SetupContext context)

Implements abstract com.fasterxml.jackson.databind.Module.setupModule.

Doc from com.fasterxml.jackson.databind.Module.setupModule.

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.

Annotations

@Override

version	back to summary
public Version version() Implements abstract com.fasterxml.jackson.databind.Module.version. Implements com.fasterxml.jackson.core.Versioned.version. Doc from com.fasterxml.jackson.databind.Module.version. Method that returns version of this module. Can be used by Jackson for informational purposes. Returns:Version Doc from com.fasterxml.jackson.core.Versioned.version. Version of the component Annotations @Override

version

back to summary

public Version version()

Implements abstract com.fasterxml.jackson.databind.Module.version.

Implements com.fasterxml.jackson.core.Versioned.version.

Doc from com.fasterxml.jackson.databind.Module.version.

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

Returns:Version

Doc from com.fasterxml.jackson.core.Versioned.version.

Version of the component

Annotations

@Override

public Class GuavaModule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail