Top Description Inners Fields Constructors Methods
com.fasterxml.jackson.databind.cfg

public abstract Class ConfigOverride

extends Object
Class Inheritance
Known Direct Subclasses
com.fasterxml.jackson.databind.cfg.ConfigOverride.Empty, com.fasterxml.jackson.databind.cfg.MutableConfigOverride
Imports
com.fasterxml.jackson.annotation.JsonAutoDetect, .JsonFormat, .JsonIgnoreProperties, .JsonInclude, .JsonSetter
Configuration object that is accessed by databinding functionality to find overrides to configuration of properties, based on declared type of the property. Such overrides have precedence over annotations attached to actual type (java.lang.Class), but can be further overridden by annotations attached to the property itself.
Since
2.8

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
ConfigOverride.Empty

Implementation used solely for "empty" instance; has no mutators and is not changed by core functionality.

Field Summary

Modifier and TypeField and Description
protected JsonFormat.Value
_format

Definitions of format overrides, if any.

protected JsonIgnoreProperties.Value
_ignorals

Definitions of property ignoral (whether to serialize, deserialize given logical property) overrides, if any.

protected JsonInclude.Value
_include

Definitions of inclusion defaults to use for properties included in this POJO type.

protected JsonInclude.Value
_includeAsProperty

Definitions of inclusion defaults for properties of this specified type (regardless of POJO in which they are included).

protected Boolean
_isIgnoredType

Flag that indicates whether "is ignorable type" is specified for this type; and if so, is it to be ignored (true) or not ignored (false); `null` is used to indicate "not specified", in which case other configuration (class annotation) is used.

protected Boolean
_mergeable

Flag that indicates whether properties of this type default to being merged or not.

protected JsonSetter.Value
_setterInfo

Definitions of setter overrides regarding null handling

protected JsonAutoDetect.Value
_visibility

Overrides for auto-detection visibility rules for this type.

Constructor Summary

AccessConstructor and Description
protected
ConfigOverride()

protected
ConfigOverride(ConfigOverride src)

Method Summary

Modifier and TypeMethod and Description
public static ConfigOverride
empty()

Accessor for immutable "empty" instance that has no configuration overrides defined.

public JsonFormat.Value
getFormat()

public JsonIgnoreProperties.Value
getIgnorals()

public JsonInclude.Value
getInclude()

public JsonInclude.Value
getIncludeAsProperty()

public Boolean
getIsIgnoredType()

public Boolean
getMergeable()

public JsonSetter.Value
getSetterInfo()

public JsonAutoDetect.Value
getVisibility()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_formatback to summary
protected JsonFormat.Value _format

Definitions of format overrides, if any.

_ignoralsback to summary
protected JsonIgnoreProperties.Value _ignorals

Definitions of property ignoral (whether to serialize, deserialize given logical property) overrides, if any.

_includeback to summary
protected JsonInclude.Value _include

Definitions of inclusion defaults to use for properties included in this POJO type. Overrides global defaults, may be overridden by per-property-type (see _includeAsProperty) and per-property overrides (annotations).

_includeAsPropertyback to summary
protected JsonInclude.Value _includeAsProperty

Definitions of inclusion defaults for properties of this specified type (regardless of POJO in which they are included). Overrides global defaults, per-POJO inclusion defaults (see {#link _include}), may be overridden by per-property overrides.

Since
2.9
_isIgnoredTypeback to summary
protected Boolean _isIgnoredType

Flag that indicates whether "is ignorable type" is specified for this type; and if so, is it to be ignored (true) or not ignored (false); `null` is used to indicate "not specified", in which case other configuration (class annotation) is used.

_mergeableback to summary
protected Boolean _mergeable

Flag that indicates whether properties of this type default to being merged or not.

_setterInfoback to summary
protected JsonSetter.Value _setterInfo

Definitions of setter overrides regarding null handling

Since
2.9
_visibilityback to summary
protected JsonAutoDetect.Value _visibility

Overrides for auto-detection visibility rules for this type.

Since
2.9

Constructor Detail

ConfigOverrideback to summary
protected ConfigOverride()
ConfigOverrideback to summary
protected ConfigOverride(ConfigOverride src)

Method Detail

emptyback to summary
public static ConfigOverride empty()

Accessor for immutable "empty" instance that has no configuration overrides defined.

Since
2.9
getFormatback to summary
public JsonFormat.Value getFormat()
getIgnoralsback to summary
public JsonIgnoreProperties.Value getIgnorals()
getIncludeback to summary
public JsonInclude.Value getInclude()
getIncludeAsPropertyback to summary
public JsonInclude.Value getIncludeAsProperty()
Since
2.9
getIsIgnoredTypeback to summary
public Boolean getIsIgnoredType()
getMergeableback to summary
public Boolean getMergeable()
Since
2.9
getSetterInfoback to summary
public JsonSetter.Value getSetterInfo()
Since
2.9
getVisibilityback to summary
public JsonAutoDetect.Value getVisibility()
Since
2.9
com.fasterxml.jackson.databind.cfg back to summary

pack-priv final Class ConfigOverride.Empty

extends ConfigOverride
Class Inheritance
Implementation used solely for "empty" instance; has no mutators and is not changed by core functionality.
Since
2.9

Field Summary

Modifier and TypeField and Description
pack-priv static final ConfigOverride.Empty
INSTANCE

Inherited from com.fasterxml.jackson.databind.cfg.ConfigOverride:
_format_ignorals_include_includeAsProperty_isIgnoredType_mergeable_setterInfo_visibility

Constructor Summary

AccessConstructor and Description
private
Empty()

Method Summary

Inherited from com.fasterxml.jackson.databind.cfg.ConfigOverride:
emptygetFormatgetIgnoralsgetIncludegetIncludeAsPropertygetIsIgnoredTypegetMergeablegetSetterInfogetVisibility

Field Detail

INSTANCEback to summary
pack-priv static final ConfigOverride.Empty INSTANCE

Constructor Detail

Emptyback to summary
private Empty()