Jackson 3.0.1 · tools.jackson.databind.DeserializationConfig

Field Summary

Modifier and Type	Field and Description
protected final AbstractTypeResolver[]	_abstractTypeResolvers List of objects that may be able to resolve abstract types to concrete types.
protected final CoercionConfigs	_coercionConfigs Configured coercion rules for coercions from secondary input shapes.
protected final int	_deserFeatures Set of `DeserializationFeature`s enabled.
protected final int	_formatReadFeatures States of `tools.jackson.core.FormatFeature`s to enable/disable.
protected final LinkedNode<DeserializationProblemHandler>	_problemHandlers Linked list that contains all registered problem handlers.
protected final int	_streamReadFeatures States of `tools.jackson.core.StreamReadFeature`s to enable/disable.
private static final long	serialVersionUID Hides tools.jackson.databind.cfg.MapperConfig.serialVersionUID.

Inherited from tools.jackson.databind.cfg.MapperConfigBase:: _attributes _classIntrospector _configOverrides _datatypeFeatures _mixIns _rootName _rootNames _subtypeResolver _typeFactory _typeResolverProvider _view EMPTY_OVERRIDE

Constructor Summary

Access	Constructor and Description
public	DeserializationConfig(MapperBuilder<?, ?> b, long mapperFeatures, int deserFeatures, int streamReadFeatures, int formatReadFeatures, ConfigOverrides configOverrides, CoercionConfigs coercionConfigs, TypeFactory tf, ClassIntrospector classIntr, MixInHandler mixins, SubtypeResolver str, ContextAttributes defaultAttrs, RootNameLookup rootNames, AbstractTypeResolver[] atrs)
private	DeserializationConfig(DeserializationConfig src, int deserFeatures, int streamReadFeatures, int formatReadFeatures)
private	DeserializationConfig(DeserializationConfig src, BaseSettings base)
private	DeserializationConfig(DeserializationConfig src, LinkedNode<DeserializationProblemHandler> problemHandlers, AbstractTypeResolver[] atr)
private	DeserializationConfig(DeserializationConfig src, PropertyName rootName)
private	DeserializationConfig(DeserializationConfig src, Class<?> view)
protected	DeserializationConfig(DeserializationConfig src, ContextAttributes attrs)
protected	DeserializationConfig(DeserializationConfig src, DatatypeFeatures dtFeatures)

Method Summary

Modifier and Type	Method and Description
private JavaType	_mapAbstractType2(JavaType type) Method that will find abstract type mapping for specified type, doing a single lookup through registered abstract type resolvers; will not do recursive lookups.
protected final DeserializationConfig	_with(DatatypeFeatures dtFeatures) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._with.
protected final DeserializationConfig	_withBase(BaseSettings newBase) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._withBase.
public Iterable<AbstractTypeResolver>	abstractTypeResolvers()
public CoercionAction	Returns: CoercionAction configured for specific coercion findCoercionAction(LogicalType Logical target type of coercion targetType, Class<?> Physical target type of coercion targetClass, CoercionInputShape Input shape to coerce from inputShape) General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested.
public CoercionAction	Returns: CoercionAction configured for specified coercion from blank string findCoercionFromBlankString(LogicalType Logical target type of coercion targetType, Class<?> Physical target type of coercion targetClass, CoercionAction Return value to use in case "blanks as empty" is not allowed actionIfBlankNotAllowed) More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one).
public Converter<Object, Object>	findDeserializationConverter(Annotated ann)
protected BaseSettings	getBaseSettings()
public final int	getDeserializationFeatures() Bulk access method for getting the bit mask of all `DeserializationFeature`s that are enabled.
public int	getFormatReadFeatures()
public LinkedNode<DeserializationProblemHandler>	getProblemHandlers() Method for getting head of the problem handler chain.
public int	getStreamReadFeatures()
public boolean	hasAbstractTypeResolvers()
public final boolean	hasDeserializationFeatures(int featureMask) Bulk access method for checking that all features specified by mask are enabled.
public final boolean	hasFormatFeature(FormatFeature f)
public final boolean	hasSomeOfFeatures(int featureMask) Bulk access method for checking that at least one of features specified by mask is enabled.
public final boolean	isEnabled(DeserializationFeature f)
public final boolean	isEnabled(StreamReadFeature f)
public JavaType	mapAbstractType(JavaType type)
public final boolean	requiresFullValue() Convenience method equivalent to: `isEnabled(DeserializationFeature.FAIL_ON_TRAILING_TOKENS)`
public boolean	useRootWrapping() Implements abstract tools.jackson.databind.cfg.MapperConfig.useRootWrapping. Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not.
public DeserializationConfig	with(ContextAttributes attrs) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.with. Method for constructing an instance that has specified contextual attributes.
public DeserializationConfig	with(DeserializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	with(DeserializationFeature first, DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	with(StreamReadFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	with(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	withFeatures(DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	withFeatures(StreamReadFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	withFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public DeserializationConfig	withHandler(DeserializationProblemHandler h) Method that can be used to add a handler that can (try to) resolve non-fatal deserialization problems.
public DeserializationConfig	withNoProblemHandlers() Method for removing all configured problem handlers; usually done to replace existing handler(s) with different one(s)
public DeserializationConfig	without(DeserializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.
public DeserializationConfig	without(DeserializationFeature first, DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public DeserializationConfig	without(StreamReadFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.
public DeserializationConfig	without(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.
public DeserializationConfig	withoutFeatures(DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public DeserializationConfig	withoutFeatures(StreamReadFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public DeserializationConfig	withoutFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public DeserializationConfig	withRootName(PropertyName rootName) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withRootName. Method for constructing and returning a new instance with different root name to use (none, if null).
public DeserializationConfig	withView(Class<?> view) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withView. Method for constructing and returning a new instance with different view to use.

Field Detail

_abstractTypeResolvers	back to summary
protected final AbstractTypeResolver[] _abstractTypeResolvers List of objects that may be able to resolve abstract types to concrete types. Used by functionality like "mr Bean" to materialize types as needed, although may be used for other kinds of defaulting as well.

_coercionConfigs	back to summary
protected final CoercionConfigs _coercionConfigs Configured coercion rules for coercions from secondary input shapes.

_deserFeatures	back to summary
protected final int _deserFeatures Set of `DeserializationFeature`s enabled.

_formatReadFeatures	back to summary
protected final int _formatReadFeatures States of `tools.jackson.core.FormatFeature`s to enable/disable.

_problemHandlers	back to summary
protected final LinkedNode<DeserializationProblemHandler> _problemHandlers Linked list that contains all registered problem handlers. Implementation as front-added linked list allows for sharing of the list (tail) without copying the list.

_streamReadFeatures	back to summary
protected final int _streamReadFeatures States of `tools.jackson.core.StreamReadFeature`s to enable/disable.

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.cfg.MapperConfig.serialVersionUID.

Constructor Detail

DeserializationConfig	back to summary
public DeserializationConfig(MapperBuilder<?, ?> b, long mapperFeatures, int deserFeatures, int streamReadFeatures, int formatReadFeatures, ConfigOverrides configOverrides, CoercionConfigs coercionConfigs, TypeFactory tf, ClassIntrospector classIntr, MixInHandler mixins, SubtypeResolver str, ContextAttributes defaultAttrs, RootNameLookup rootNames, AbstractTypeResolver[] atrs) Since 3.0

DeserializationConfig	back to summary
private DeserializationConfig(DeserializationConfig src, int deserFeatures, int streamReadFeatures, int formatReadFeatures)

DeserializationConfig	back to summary
private DeserializationConfig(DeserializationConfig src, BaseSettings base)

DeserializationConfig	back to summary
private DeserializationConfig(DeserializationConfig src, LinkedNode<DeserializationProblemHandler> problemHandlers, AbstractTypeResolver[] atr)

DeserializationConfig	back to summary
private DeserializationConfig(DeserializationConfig src, PropertyName rootName)

DeserializationConfig	back to summary
private DeserializationConfig(DeserializationConfig src, Class<?> view)

DeserializationConfig	back to summary
protected DeserializationConfig(DeserializationConfig src, ContextAttributes attrs)

DeserializationConfig	back to summary
protected DeserializationConfig(DeserializationConfig src, DatatypeFeatures dtFeatures)

Method Detail

_mapAbstractType2	back to summary
private JavaType _mapAbstractType2(JavaType type) Method that will find abstract type mapping for specified type, doing a single lookup through registered abstract type resolvers; will not do recursive lookups.

_with	back to summary
protected final DeserializationConfig _with(DatatypeFeatures dtFeatures) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._with. Annotations @Override

_with

back to summary

protected final DeserializationConfig _with(DatatypeFeatures dtFeatures)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase._with.

Annotations

@Override

_withBase	back to summary
protected final DeserializationConfig _withBase(BaseSettings newBase) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._withBase. Annotations @Override

_withBase

back to summary

protected final DeserializationConfig _withBase(BaseSettings newBase)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase._withBase.

Annotations

@Override

abstractTypeResolvers	back to summary
public Iterable<AbstractTypeResolver> abstractTypeResolvers() Since 3.0

findCoercionAction	back to summary
public CoercionAction findCoercionAction(LogicalType targetType, Class<?> targetClass, CoercionInputShape inputShape) General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested. Parameters targetType:LogicalType Logical target type of coercion targetClass:Class<?> Physical target type of coercion inputShape:CoercionInputShape Input shape to coerce from Returns:CoercionAction CoercionAction configured for specific coercion Since 2.12

findCoercionAction

back to summary

public CoercionAction findCoercionAction(LogicalType targetType, Class<?> targetClass, CoercionInputShape inputShape)

General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested.

Parameters

targetType:LogicalType: Logical target type of coercion
targetClass:Class<?>: Physical target type of coercion
inputShape:CoercionInputShape: Input shape to coerce from

Returns:CoercionAction

CoercionAction configured for specific coercion

Since

2.12

findCoercionFromBlankString back to summary

findCoercionFromBlankString	back to summary
public CoercionAction findCoercionFromBlankString(LogicalType targetType, Class<?> targetClass, CoercionAction actionIfBlankNotAllowed) More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one). Will basically first determine if "blank as empty" is allowed: if not, returns `actionIfBlankNotAllowed`, otherwise returns action for `CoercionInputShape#EmptyString`. Parameters targetType:LogicalType Logical target type of coercion targetClass:Class<?> Physical target type of coercion actionIfBlankNotAllowed:CoercionAction Return value to use in case "blanks as empty" is not allowed Returns:CoercionAction CoercionAction configured for specified coercion from blank string Since 2.12

public CoercionAction findCoercionFromBlankString(LogicalType targetType, Class<?> targetClass, CoercionAction actionIfBlankNotAllowed)

More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one). Will basically first determine if "blank as empty" is allowed: if not, returns actionIfBlankNotAllowed, otherwise returns action for CoercionInputShape#EmptyString.

Parameters

targetType:LogicalType: Logical target type of coercion
targetClass:Class<?>: Physical target type of coercion
actionIfBlankNotAllowed:CoercionAction: Return value to use in case "blanks as empty" is not allowed

Returns:CoercionAction

CoercionAction configured for specified coercion from blank string

Since

2.12

findDeserializationConverter	back to summary
public Converter<Object, Object> findDeserializationConverter(Annotated ann)

getBaseSettings	back to summary
protected BaseSettings getBaseSettings()

getDeserializationFeatures	back to summary
public final int getDeserializationFeatures() Bulk access method for getting the bit mask of all `DeserializationFeature`s that are enabled.

getFormatReadFeatures	back to summary
public int getFormatReadFeatures() Since 3.0

getProblemHandlers	back to summary
public LinkedNode<DeserializationProblemHandler> getProblemHandlers() Method for getting head of the problem handler chain. May be null, if no handlers have been added.

getStreamReadFeatures	back to summary
public int getStreamReadFeatures() Since 3.0

hasAbstractTypeResolvers	back to summary
public boolean hasAbstractTypeResolvers() Since 3.0

hasDeserializationFeatures	back to summary
public final boolean hasDeserializationFeatures(int featureMask) Bulk access method for checking that all features specified by mask are enabled.

hasFormatFeature	back to summary
public final boolean hasFormatFeature(FormatFeature f)

hasSomeOfFeatures	back to summary
public final boolean hasSomeOfFeatures(int featureMask) Bulk access method for checking that at least one of features specified by mask is enabled.

isEnabled	back to summary
public final boolean isEnabled(DeserializationFeature f)

isEnabled	back to summary
public final boolean isEnabled(StreamReadFeature f)

mapAbstractType	back to summary
public JavaType mapAbstractType(JavaType type) Since 3.0

requiresFullValue	back to summary
public final boolean requiresFullValue() Convenience method equivalent to: `isEnabled(DeserializationFeature.FAIL_ON_TRAILING_TOKENS)`

useRootWrapping	back to summary
public boolean useRootWrapping() Implements abstract tools.jackson.databind.cfg.MapperConfig.useRootWrapping. Doc from tools.jackson.databind.cfg.MapperConfig.useRootWrapping. Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not. Annotations @Override

useRootWrapping

back to summary

public boolean useRootWrapping()

Implements abstract tools.jackson.databind.cfg.MapperConfig.useRootWrapping.

Doc from tools.jackson.databind.cfg.MapperConfig.useRootWrapping.

Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not.

Annotations

@Override

with	back to summary
public DeserializationConfig with(ContextAttributes attrs) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.with. Doc from tools.jackson.databind.cfg.MapperConfigBase.with. Method for constructing an instance that has specified contextual attributes. Annotations @Override

with

back to summary

public DeserializationConfig with(ContextAttributes attrs)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase.with.

Doc from tools.jackson.databind.cfg.MapperConfigBase.with.

Method for constructing an instance that has specified contextual attributes.

Annotations

@Override

with	back to summary
public DeserializationConfig with(DeserializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

with	back to summary
public DeserializationConfig with(DeserializationFeature first, DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

with	back to summary
public DeserializationConfig with(StreamReadFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

with	back to summary
public DeserializationConfig with(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFeatures	back to summary
public DeserializationConfig withFeatures(DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFeatures	back to summary
public DeserializationConfig withFeatures(StreamReadFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFeatures	back to summary
public DeserializationConfig withFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withHandler	back to summary
public DeserializationConfig withHandler(DeserializationProblemHandler h) Method that can be used to add a handler that can (try to) resolve non-fatal deserialization problems.

withNoProblemHandlers	back to summary
public DeserializationConfig withNoProblemHandlers() Method for removing all configured problem handlers; usually done to replace existing handler(s) with different one(s)

without	back to summary
public DeserializationConfig without(DeserializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

without	back to summary
public DeserializationConfig without(DeserializationFeature first, DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

without	back to summary
public DeserializationConfig without(StreamReadFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

without	back to summary
public DeserializationConfig without(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

withoutFeatures	back to summary
public DeserializationConfig withoutFeatures(DeserializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withoutFeatures	back to summary
public DeserializationConfig withoutFeatures(StreamReadFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withoutFeatures	back to summary
public DeserializationConfig withoutFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withRootName back to summary

public DeserializationConfig withRootName(PropertyName rootName)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withRootName.

Doc from tools.jackson.databind.cfg.MapperConfigBase.withRootName.

Method for constructing and returning a new instance with different root name to use (none, if null).

Note that when a root name is set to a non-Empty String, this will automatically force use of root element wrapping with given name. If empty String passed, will disable root name wrapping; and if null used, will instead use SerializationFeature to determine if to use wrapping, and annotation (or default name) for actual root name to use.

Annotations

@Override

withView

back to summary

public DeserializationConfig withView(Class<?> view)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withView.

Doc from tools.jackson.databind.cfg.MapperConfigBase.withView.

Method for constructing and returning a new instance with different view to use.

Annotations

@Override

public final Class DeserializationConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail