Module tools.jackson.databind

Package tools.jackson.databind.deser

Class BasicDeserializerFactory

java.lang.Object

tools.jackson.databind.deser.DeserializerFactory

tools.jackson.databind.deser.BasicDeserializerFactory

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BeanDeserializerFactory

public abstract class BasicDeserializerFactory
extends DeserializerFactory
implements Serializable

Abstract factory base class that can provide deserializers for standard JDK classes, including collection classes and simple heuristics for "up-casting" common collection interface types (such as Collection).

Since all simple deserializers are eagerly instantiated, and there is no additional introspection or customizability of these types, this factory is stateless.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BasicDeserializerFactory.ContainerDefaultMappings	Helper class to contain default mappings for abstract JDK Collection and Map types.

Field Summary

Fields

Modifier and Type	Field	Description
protected final DeserializerFactoryConfig	_factoryConfig	Configuration settings for this factory; immutable instance (just like this factory), new version created via copy-constructor (fluent-style)

Fields inherited from class tools.jackson.databind.deser.DeserializerFactory

NO_DESERIALIZERS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicDeserializerFactory(DeserializerFactoryConfig config)

Method Summary

Modifier and Type	Method	Description
protected ValueInstantiator	_constructDefaultValueInstantiator(DeserializationContext ctxt, BeanDescription.Supplier beanDescRef)	Method that will construct standard default ValueInstantiator using annotations (like @JsonCreator) and visibility rules
protected ValueDeserializer<?>	_findCustomArrayDeserializer(ArrayType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)
protected ValueDeserializer<Object>	_findCustomBeanDeserializer(JavaType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef)
protected ValueDeserializer<?>	_findCustomCollectionDeserializer(CollectionType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)
protected ValueDeserializer<?>	_findCustomCollectionLikeDeserializer(CollectionLikeType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)
protected ValueDeserializer<?>	_findCustomEnumDeserializer(JavaType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef)
protected ValueDeserializer<?>	_findCustomMapDeserializer(MapType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)
protected ValueDeserializer<?>	_findCustomMapLikeDeserializer(MapLikeType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)
protected ValueDeserializer<?>	_findCustomReferenceDeserializer(ReferenceType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer contentTypeDeserializer, ValueDeserializer<?> contentDeserializer)
protected ValueDeserializer<?>	_findCustomTreeNodeDeserializer(JavaType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef)
protected boolean	_hasCreatorAnnotation(MapperConfig<?> config, Annotated ann)
protected CollectionType	_mapAbstractCollectionType(JavaType type, DeserializationConfig config)
protected MapType	_mapAbstractMapType(JavaType type, DeserializationConfig config)
ValueInstantiator	_valueInstantiatorInstance(DeserializationConfig config, Annotated annotated, Object instDef)
protected SettableBeanProperty	constructCreatorProperty(DeserializationContext ctxt, BeanDescription.Supplier beanDescRef, PropertyName name, int index, AnnotatedParameter param, JacksonInject.Value injectable)	Method that will construct a property object that represents a logical property passed via Creator (constructor or static factory method)
protected EnumResolver	constructEnumNamingStrategyResolver(DeserializationConfig config, AnnotatedClass enumClass)	Factory method used to resolve an instance of CompactStringObjectMap with EnumNamingStrategy applied for the target class.
protected EnumResolver	constructEnumResolver(DeserializationContext ctxt, Class<?> enumClass, BeanDescription.Supplier beanDescRef)
ValueDeserializer<?>	createArrayDeserializer(DeserializationContext ctxt, ArrayType type, BeanDescription.Supplier beanDescRef)	Method called to create (or, for completely immutable deserializers, reuse) a deserializer that can convert JSON content into values of specified Java type.
ValueDeserializer<?>	createCollectionDeserializer(DeserializationContext ctxt, CollectionType type, BeanDescription.Supplier beanDescRef)
ValueDeserializer<?>	createCollectionLikeDeserializer(DeserializationContext ctxt, CollectionLikeType type, BeanDescription.Supplier beanDescRef)
ValueDeserializer<?>	createEnumDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription.Supplier beanDescRef)	Factory method for constructing deserializers of Enum types.
KeyDeserializer	createKeyDeserializer(DeserializationContext ctxt, JavaType type)	Method called to find if factory knows how to create a key deserializer for specified type; currently this means checking if a module has registered possible deserializers.
ValueDeserializer<?>	createMapDeserializer(DeserializationContext ctxt, MapType type, BeanDescription.Supplier beanDescRef)
ValueDeserializer<?>	createMapLikeDeserializer(DeserializationContext ctxt, MapLikeType type, BeanDescription.Supplier beanDescRef)
ValueDeserializer<?>	createReferenceDeserializer(DeserializationContext ctxt, ReferenceType type, BeanDescription.Supplier beanDescRef)
ValueDeserializer<?>	createTreeDeserializer(DeserializationConfig config, JavaType nodeType, BeanDescription.Supplier beanDescRef)	Method called to create and return a deserializer that can construct JsonNode(s) from JSON content.
protected ValueDeserializer<Object>	findContentDeserializerFromAnnotation(DeserializationContext ctxt, Annotated ann)
ValueDeserializer<?>	findDefaultDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription.Supplier beanDescRef)	Helper method called to find one of default deserializers for "well-known" platform types: JDK-provided types, and small number of public Jackson API types.
protected ValueDeserializer<Object>	findDeserializerFromAnnotation(DeserializationContext ctxt, Annotated ann)	Helper method called to check if a class or method has annotation that tells which class to use for deserialization; and if so, to instantiate, that deserializer to use.
protected KeyDeserializer	findKeyDeserializerFromAnnotation(DeserializationContext ctxt, Annotated ann)	Helper method called to check if a class or method has annotation that tells which class to use for deserialization of Map keys.
protected ValueDeserializer<?>	findOptionalStdDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription.Supplier beanDescRef)	Overridable method called after checking all other types.
ValueInstantiator	findValueInstantiator(DeserializationContext ctxt, BeanDescription.Supplier beanDescRef)	Value instantiator is created both based on creator annotations, and on optional externally provided instantiators (registered through module interface).
DeserializerFactoryConfig	getFactoryConfig()	Method for getting current DeserializerFactoryConfig.
boolean	hasExplicitDeserializerFor(DatabindContext ctxt, Class<?> valueType)	Method that can be used to check if databind module has deserializer for given (likely JDK) type: explicit meaning that it is not automatically generated for POJO.
protected JavaType	resolveMemberAndTypeAnnotations(DeserializationContext ctxt, AnnotatedMember member, JavaType type)	Helper method used to resolve additional type-related annotation information like type overrides, or handler (serializer, deserializer) overrides, so that from declared field, property or constructor parameter type is used as the base and modified based on annotations, if any.
final DeserializerFactory	withAdditionalDeserializers(Deserializers additional)	Convenience method for creating a new factory instance with additional deserializer provider.
final DeserializerFactory	withAdditionalKeyDeserializers(KeyDeserializers additional)	Convenience method for creating a new factory instance with additional KeyDeserializers.
protected abstract DeserializerFactory	withConfig(DeserializerFactoryConfig config)
final DeserializerFactory	withDeserializerModifier(ValueDeserializerModifier modifier)	Convenience method for creating a new factory instance with additional ValueDeserializerModifier.
final DeserializerFactory	withValueInstantiators(ValueInstantiators instantiators)	Convenience method for creating a new factory instance with additional ValueInstantiators.

Methods inherited from class tools.jackson.databind.deser.DeserializerFactory

createBeanDeserializer, createBuilderBasedDeserializer

Methods inherited from class java.lang.Object

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

Field Details

_factoryConfig

protected final DeserializerFactoryConfig _factoryConfig

Configuration settings for this factory; immutable instance (just like this factory), new version created via copy-constructor (fluent-style)

Constructor Details

BasicDeserializerFactory

protected BasicDeserializerFactory(DeserializerFactoryConfig config)

Method Details

getFactoryConfig

public DeserializerFactoryConfig getFactoryConfig()

Method for getting current DeserializerFactoryConfig.

Note that since instances are immutable, you CANNOT change settings by accessing an instance and calling methods: this will simply create new instance of config object.

withConfig

protected abstract DeserializerFactory withConfig(DeserializerFactoryConfig config)

withAdditionalDeserializers

public final DeserializerFactory withAdditionalDeserializers(Deserializers additional)

Convenience method for creating a new factory instance with additional deserializer provider.

Specified by:

withAdditionalDeserializers in class DeserializerFactory

withAdditionalKeyDeserializers

public final DeserializerFactory withAdditionalKeyDeserializers(KeyDeserializers additional)

Convenience method for creating a new factory instance with additional KeyDeserializers.

Specified by:

withAdditionalKeyDeserializers in class DeserializerFactory

withDeserializerModifier

public final DeserializerFactory withDeserializerModifier(ValueDeserializerModifier modifier)

Convenience method for creating a new factory instance with additional ValueDeserializerModifier.

Specified by:

withDeserializerModifier in class DeserializerFactory

withValueInstantiators

public final DeserializerFactory withValueInstantiators(ValueInstantiators instantiators)

Convenience method for creating a new factory instance with additional ValueInstantiators.

Specified by:

withValueInstantiators in class DeserializerFactory

findValueInstantiator

public ValueInstantiator findValueInstantiator(DeserializationContext ctxt,
 BeanDescription.Supplier beanDescRef)

Value instantiator is created both based on creator annotations, and on optional externally provided instantiators (registered through module interface).

Specified by:

findValueInstantiator in class DeserializerFactory

_constructDefaultValueInstantiator

protected ValueInstantiator _constructDefaultValueInstantiator(DeserializationContext ctxt,
 BeanDescription.Supplier beanDescRef)

Method that will construct standard default ValueInstantiator using annotations (like @JsonCreator) and visibility rules

_valueInstantiatorInstance

public ValueInstantiator _valueInstantiatorInstance(DeserializationConfig config,
 Annotated annotated,
 Object instDef)

constructCreatorProperty

protected SettableBeanProperty constructCreatorProperty(DeserializationContext ctxt,
 BeanDescription.Supplier beanDescRef,
 PropertyName name,
 int index,
 AnnotatedParameter param,
 JacksonInject.Value injectable)

Method that will construct a property object that represents a logical property passed via Creator (constructor or static factory method)

createArrayDeserializer

public ValueDeserializer<?> createArrayDeserializer(DeserializationContext ctxt,
 ArrayType type,
 BeanDescription.Supplier beanDescRef)

Description copied from class: DeserializerFactory

Method called to create (or, for completely immutable deserializers, reuse) a deserializer that can convert JSON content into values of specified Java type.

Specified by:

createArrayDeserializer in class DeserializerFactory

type - Type to be deserialized

createCollectionDeserializer

public ValueDeserializer<?> createCollectionDeserializer(DeserializationContext ctxt,
 CollectionType type,
 BeanDescription.Supplier beanDescRef)

Specified by:

createCollectionDeserializer in class DeserializerFactory

_mapAbstractCollectionType

protected CollectionType _mapAbstractCollectionType(JavaType type,
 DeserializationConfig config)

createCollectionLikeDeserializer

public ValueDeserializer<?> createCollectionLikeDeserializer(DeserializationContext ctxt,
 CollectionLikeType type,
 BeanDescription.Supplier beanDescRef)

Specified by:

createCollectionLikeDeserializer in class DeserializerFactory

createMapDeserializer

public ValueDeserializer<?> createMapDeserializer(DeserializationContext ctxt,
 MapType type,
 BeanDescription.Supplier beanDescRef)

Specified by:

createMapDeserializer in class DeserializerFactory

_mapAbstractMapType

protected MapType _mapAbstractMapType(JavaType type,
 DeserializationConfig config)

createMapLikeDeserializer

public ValueDeserializer<?> createMapLikeDeserializer(DeserializationContext ctxt,
 MapLikeType type,
 BeanDescription.Supplier beanDescRef)

Specified by:

createMapLikeDeserializer in class DeserializerFactory

createEnumDeserializer

public ValueDeserializer<?> createEnumDeserializer(DeserializationContext ctxt,
 JavaType type,
 BeanDescription.Supplier beanDescRef)

Factory method for constructing deserializers of Enum types.

Specified by:

createEnumDeserializer in class DeserializerFactory

createTreeDeserializer

public ValueDeserializer<?> createTreeDeserializer(DeserializationConfig config,
 JavaType nodeType,
 BeanDescription.Supplier beanDescRef)

Description copied from class: DeserializerFactory

Method called to create and return a deserializer that can construct JsonNode(s) from JSON content.

Specified by:

createTreeDeserializer in class DeserializerFactory

createReferenceDeserializer

public ValueDeserializer<?> createReferenceDeserializer(DeserializationContext ctxt,
 ReferenceType type,
 BeanDescription.Supplier beanDescRef)

Specified by:

createReferenceDeserializer in class DeserializerFactory

findOptionalStdDeserializer

protected ValueDeserializer<?> findOptionalStdDeserializer(DeserializationContext ctxt,
 JavaType type,
 BeanDescription.Supplier beanDescRef)

Overridable method called after checking all other types.

createKeyDeserializer

public KeyDeserializer createKeyDeserializer(DeserializationContext ctxt,
 JavaType type)

Description copied from class: DeserializerFactory

Method called to find if factory knows how to create a key deserializer for specified type; currently this means checking if a module has registered possible deserializers.

Specified by:

createKeyDeserializer in class DeserializerFactory

Returns:

Key deserializer to use for specified type, if one found; null if not (and default key deserializer should be used)

hasExplicitDeserializerFor

public boolean hasExplicitDeserializerFor(DatabindContext ctxt,
 Class<?> valueType)

Method that can be used to check if databind module has deserializer for given (likely JDK) type: explicit meaning that it is not automatically generated for POJO.

This matches Deserializers.hasDeserializerFor(tools.jackson.databind.DeserializationConfig, java.lang.Class<?>) method.

Specified by:

hasExplicitDeserializerFor in class DeserializerFactory

Since:

3.0

findDefaultDeserializer

public ValueDeserializer<?> findDefaultDeserializer(DeserializationContext ctxt,
 JavaType type,
 BeanDescription.Supplier beanDescRef)

Helper method called to find one of default deserializers for "well-known" platform types: JDK-provided types, and small number of public Jackson API types.

_findCustomTreeNodeDeserializer

protected ValueDeserializer<?> _findCustomTreeNodeDeserializer(JavaType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef)

_findCustomReferenceDeserializer

protected ValueDeserializer<?> _findCustomReferenceDeserializer(ReferenceType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef,
 TypeDeserializer contentTypeDeserializer,
 ValueDeserializer<?> contentDeserializer)

_findCustomBeanDeserializer

protected ValueDeserializer<Object> _findCustomBeanDeserializer(JavaType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef)

_findCustomArrayDeserializer

protected ValueDeserializer<?> _findCustomArrayDeserializer(ArrayType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef,
 TypeDeserializer elementTypeDeserializer,
 ValueDeserializer<?> elementDeserializer)

_findCustomCollectionDeserializer

protected ValueDeserializer<?> _findCustomCollectionDeserializer(CollectionType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef,
 TypeDeserializer elementTypeDeserializer,
 ValueDeserializer<?> elementDeserializer)

_findCustomCollectionLikeDeserializer

protected ValueDeserializer<?> _findCustomCollectionLikeDeserializer(CollectionLikeType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef,
 TypeDeserializer elementTypeDeserializer,
 ValueDeserializer<?> elementDeserializer)

_findCustomEnumDeserializer

protected ValueDeserializer<?> _findCustomEnumDeserializer(JavaType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef)

_findCustomMapDeserializer

protected ValueDeserializer<?> _findCustomMapDeserializer(MapType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef,
 KeyDeserializer keyDeserializer,
 TypeDeserializer elementTypeDeserializer,
 ValueDeserializer<?> elementDeserializer)

_findCustomMapLikeDeserializer

protected ValueDeserializer<?> _findCustomMapLikeDeserializer(MapLikeType type,
 DeserializationConfig config,
 BeanDescription.Supplier beanDescRef,
 KeyDeserializer keyDeserializer,
 TypeDeserializer elementTypeDeserializer,
 ValueDeserializer<?> elementDeserializer)

findDeserializerFromAnnotation

protected ValueDeserializer<Object> findDeserializerFromAnnotation(DeserializationContext ctxt,
 Annotated ann)

Helper method called to check if a class or method has annotation that tells which class to use for deserialization; and if so, to instantiate, that deserializer to use. Note that deserializer will NOT yet be contextualized so caller needs to take care to call contextualization appropriately. Returns null if no such annotation found.

findKeyDeserializerFromAnnotation

protected KeyDeserializer findKeyDeserializerFromAnnotation(DeserializationContext ctxt,
 Annotated ann)

Helper method called to check if a class or method has annotation that tells which class to use for deserialization of Map keys. Returns null if no such annotation found.

findContentDeserializerFromAnnotation

protected ValueDeserializer<Object> findContentDeserializerFromAnnotation(DeserializationContext ctxt,
 Annotated ann)

resolveMemberAndTypeAnnotations

protected JavaType resolveMemberAndTypeAnnotations(DeserializationContext ctxt,
 AnnotatedMember member,
 JavaType type)

Helper method used to resolve additional type-related annotation information like type overrides, or handler (serializer, deserializer) overrides, so that from declared field, property or constructor parameter type is used as the base and modified based on annotations, if any.

constructEnumResolver

protected EnumResolver constructEnumResolver(DeserializationContext ctxt,
 Class<?> enumClass,
 BeanDescription.Supplier beanDescRef)

constructEnumNamingStrategyResolver

protected EnumResolver constructEnumNamingStrategyResolver(DeserializationConfig config,
 AnnotatedClass enumClass)

Factory method used to resolve an instance of CompactStringObjectMap with EnumNamingStrategy applied for the target class.

_hasCreatorAnnotation

protected boolean _hasCreatorAnnotation(MapperConfig<?> config,
 Annotated ann)