Top Description Fields Constructors Methods
tools.jackson.databind.cfg

public Class ConfigOverrides

extends Object
implements Serializable, Snapshottable<ConfigOverrides>
Class Inheritance
All Implemented Interfaces
tools.jackson.core.util.Snapshottable, java.io.Serializable
Imports
java.util.*, com.fasterxml.jackson.annotation.JsonAutoDetect, .JsonFormat, .JsonInclude, .JsonSetter, tools.jackson.core.util.Snapshottable, tools.jackson.databind.introspect.VisibilityChecker
Container for individual ConfigOverride values.

Field Summary

Modifier and TypeField and Description
protected JsonInclude.Value
_defaultInclusion

protected Boolean
_defaultLeniency

protected Boolean
_defaultMergeable

protected JsonSetter.Value
_defaultNullHandling

protected Map<Class<?>, MutableConfigOverride>
_overrides

Per-type override definitions

protected VisibilityChecker
_visibilityChecker

private static final VisibilityChecker
DEFAULT_RECORD_VISIBILITY_CHECKER

private static final VisibilityChecker
DEFAULT_VISIBILITY_CHECKER

pack-priv static final JsonInclude.Value
INCLUDE_DEFAULT

Convenience value used as the default root setting.

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
ConfigOverrides()

protected
ConfigOverrides(Map<Class<?>, MutableConfigOverride> overrides, JsonInclude.Value defIncl, JsonSetter.Value defSetter, VisibilityChecker defVisibility, Boolean defMergeable, Boolean defLeniency)

Method Summary

Modifier and TypeMethod and Description
protected Map<Class<?>, MutableConfigOverride>
_newMap()

public JsonFormat.Value

Returns:

Default format settings for type; never null.
findFormatDefaults(Class<?> type)

Specific accessor for finding {code JsonFormat.Value} for given type, considering global default for leniency as well as per-type format override (if any).

public MutableConfigOverride
findOrCreateOverride(Class<?> type)

public ConfigOverride
findOverride(Class<?> type)

public JsonInclude.Value
getDefaultInclusion()

public Boolean
getDefaultLeniency()

public Boolean
getDefaultMergeable()

public JsonSetter.Value
getDefaultNullHandling()

public VisibilityChecker
getDefaultRecordVisibility()

Alternate accessor needed due to complexities of Record auto-discovery: needs to obey custom overrides but also give alternate "default default" if no customizations made.

public VisibilityChecker
getDefaultVisibility()

public ConfigOverrides
setDefaultInclusion(JsonInclude.Value v)

public ConfigOverrides
setDefaultLeniency(Boolean b)

public ConfigOverrides
setDefaultMergeable(Boolean b)

public ConfigOverrides
setDefaultNullHandling(JsonSetter.Value v)

public ConfigOverrides
setDefaultVisibility(VisibilityChecker v)

public ConfigOverrides
setDefaultVisibility(JsonAutoDetect.Value vis)

public ConfigOverrides
snapshot()

Implements tools.jackson.core.util.Snapshottable.snapshot.

Method to call to get an instance that may not be modified through any other object, including `this`.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

_defaultInclusionback to summary
protected JsonInclude.Value _defaultInclusion
_defaultLeniencyback to summary
protected Boolean _defaultLeniency
_defaultMergeableback to summary
protected Boolean _defaultMergeable
_defaultNullHandlingback to summary
protected JsonSetter.Value _defaultNullHandling
_overridesback to summary
protected Map<Class<?>, MutableConfigOverride> _overrides

Per-type override definitions

_visibilityCheckerback to summary
protected VisibilityChecker _visibilityChecker
DEFAULT_RECORD_VISIBILITY_CHECKERback to summary
private static final VisibilityChecker DEFAULT_RECORD_VISIBILITY_CHECKER
DEFAULT_VISIBILITY_CHECKERback to summary
private static final VisibilityChecker DEFAULT_VISIBILITY_CHECKER
INCLUDE_DEFAULTback to summary
pack-priv static final JsonInclude.Value INCLUDE_DEFAULT

Convenience value used as the default root setting. Note that although in a way it would make sense use "ALWAYS" for both, problems arise in some cases where default is seen as explicit setting, overriding possible per-class annotation; hence use of "USE_DEFAULTS".

Since
3.0
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

ConfigOverridesback to summary
public ConfigOverrides()
ConfigOverridesback to summary
protected ConfigOverrides(Map<Class<?>, MutableConfigOverride> overrides, JsonInclude.Value defIncl, JsonSetter.Value defSetter, VisibilityChecker defVisibility, Boolean defMergeable, Boolean defLeniency)

Method Detail

_newMapback to summary
protected Map<Class<?>, MutableConfigOverride> _newMap()
findFormatDefaultsback to summary
public JsonFormat.Value findFormatDefaults(Class<?> type)

Specific accessor for finding {code JsonFormat.Value} for given type, considering global default for leniency as well as per-type format override (if any).

Returns:JsonFormat.Value

Default format settings for type; never null.

Since
2.10
findOrCreateOverrideback to summary
public MutableConfigOverride findOrCreateOverride(Class<?> type)
findOverrideback to summary
public ConfigOverride findOverride(Class<?> type)
getDefaultInclusionback to summary
public JsonInclude.Value getDefaultInclusion()
getDefaultLeniencyback to summary
public Boolean getDefaultLeniency()
getDefaultMergeableback to summary
public Boolean getDefaultMergeable()
getDefaultNullHandlingback to summary
public JsonSetter.Value getDefaultNullHandling()
getDefaultRecordVisibilityback to summary
public VisibilityChecker getDefaultRecordVisibility()

Alternate accessor needed due to complexities of Record auto-discovery: needs to obey custom overrides but also give alternate "default default" if no customizations made.

Since
3.0
getDefaultVisibilityback to summary
public VisibilityChecker getDefaultVisibility()
setDefaultInclusionback to summary
public ConfigOverrides setDefaultInclusion(JsonInclude.Value v)
setDefaultLeniencyback to summary
public ConfigOverrides setDefaultLeniency(Boolean b)
setDefaultMergeableback to summary
public ConfigOverrides setDefaultMergeable(Boolean b)
setDefaultNullHandlingback to summary
public ConfigOverrides setDefaultNullHandling(JsonSetter.Value v)
setDefaultVisibilityback to summary
public ConfigOverrides setDefaultVisibility(VisibilityChecker v)
setDefaultVisibilityback to summary
public ConfigOverrides setDefaultVisibility(JsonAutoDetect.Value vis)
snapshotback to summary
public ConfigOverrides snapshot()

Implements tools.jackson.core.util.Snapshottable.snapshot.

Doc from tools.jackson.core.util.Snapshottable.snapshot.

Method to call to get an instance that may not be modified through any other object, including `this`. That instance may be `this` if (and only if) this instance is effectively immutable (unmodifiable) through its API: if this is not the case, a new copy with same configuration must be created and returned.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override