Top Description Inners Methods
tools.jackson.databind.deser

public Interface Deserializers

Known Direct Implementers
tools.jackson.databind.deser.Deserializers.Base
Imports
tools.jackson.core.TreeNode, tools.jackson.databind.*, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.*

Interface that defines API for simple extensions that can provide additional deserializers for various types. Access is by a single callback method; instance is to either return a configured ValueDeserializer for specified type, or null to indicate that it does not support handling of the type. In latter case, further calls can be made for other providers; in former case returned deserializer is used for handling of instances of specified type.

It is strongly recommended that implementations always extend Deserializers.Base and NOT just implement Deserializers.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract static class
Deserializers.Base

Basic Deserializers implementation that implements all methods but provides no deserializers.

Method Summary

Modifier and TypeMethod and Description
public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findArrayDeserializer
(ArrayType
Type of array instances to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
,
TypeDeserializer
If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.
elementTypeDeserializer
,
ValueDeserializer<?>
Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.
elementDeserializer
)

Method called to locate deserializer for specified array type.

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findBeanDeserializer
(JavaType
Bean type to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
)

Method called to locate deserializer for specified value type which does not belong to any other category (not an Enum, Collection, Map, Array, reference value or tree node)

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findCollectionDeserializer
(CollectionType
Type of collection instances to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
,
TypeDeserializer
If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.
elementTypeDeserializer
,
ValueDeserializer<?>
Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.
elementDeserializer
)

Method called to locate deserializer for specified java.util.Collection (List, Set etc) type.

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findCollectionLikeDeserializer
(CollectionLikeType
Type of instances to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
,
TypeDeserializer
If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.
elementTypeDeserializer
,
ValueDeserializer<?>
Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.
elementDeserializer
)

Method called to locate deserializer for specified "Collection-like" type (one that acts like java.util.Collection but does not implement it).

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findEnumDeserializer
(JavaType
Type of java.lang.Enum instances to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
)

Method called to locate deserializer for specified java.lang.Enum type.

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findMapDeserializer
(MapType
Type of java.util.Map instances to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
,
KeyDeserializer
Key deserializer use, if it is defined via annotations or other configuration; null if default key deserializer for key type can be used.
keyDeserializer
,
TypeDeserializer
If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.
elementTypeDeserializer
,
ValueDeserializer<?>
Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.
elementDeserializer
)

Method called to locate deserializer for specified java.util.Map type.

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findMapLikeDeserializer
(MapLikeType
Type of java.util.Map instances to deserialize
type
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers
beanDescRef
,
KeyDeserializer
Key deserializer use, if it is defined via annotations or other configuration; null if default key deserializer for key type can be used.
keyDeserializer
,
TypeDeserializer
If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.
elementTypeDeserializer
,
ValueDeserializer<?>
Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.
elementDeserializer
)

Method called to locate deserializer for specified "Map-like" type (one that acts like java.util.Map but does not implement it).

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findReferenceDeserializer
(ReferenceType
Specific referential type to deserialize
refType
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier
Definition of the reference type that contains class annotations and other information typically needed for building deserializers
beanDescRef
,
TypeDeserializer
Possible type deserializer for referenced value
contentTypeDeserializer
,
ValueDeserializer<?>
Value deserializer to use for referenced value, if indicated by property annotation
contentDeserializer
)

Method called to locate deserializer for value that is of referential type,

public default ValueDeserializer<?>

Returns:

Deserializer to use for the type; or null if this provider does not know how to construct it
findTreeNodeDeserializer
(JavaType
Specific type of JSON tree nodes to deserialize (subtype of TreeNode)
nodeType
,
DeserializationConfig
Configuration in effect
config
,
BeanDescription.Supplier beanDescRef)

Method called to locate deserializer for specified JSON tree node type.

public boolean
hasDeserializerFor(DeserializationConfig config, Class<?> valueType)

Method that may be called to check whether this deserializer provider would provide deserializer for values of given type, without attempting to construct (and possibly fail in some cases) actual deserializer.

Method Detail

findArrayDeserializerback to summary
public default ValueDeserializer<?> findArrayDeserializer(ArrayType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)

Method called to locate deserializer for specified array type.

Deserializer for element type may be passed, if configured explicitly at higher level (by annotations, typically), but usually are not. Type deserializer for element is passed if one is needed based on contextual information (annotations on declared element class; or on field or method type is associated with).

Parameters
type:ArrayType

Type of array instances to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

elementTypeDeserializer:TypeDeserializer

If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.

elementDeserializer:ValueDeserializer<?>

Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findBeanDeserializerback to summary
public default ValueDeserializer<?> findBeanDeserializer(JavaType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef)

Method called to locate deserializer for specified value type which does not belong to any other category (not an Enum, Collection, Map, Array, reference value or tree node)

Parameters
type:JavaType

Bean type to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findCollectionDeserializerback to summary
public default ValueDeserializer<?> findCollectionDeserializer(CollectionType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)

Method called to locate deserializer for specified java.util.Collection (List, Set etc) type.

Deserializer for element type may be passed, if configured explicitly at higher level (by annotations, typically), but usually are not. Type deserializer for element is passed if one is needed based on contextual information (annotations on declared element class; or on field or method type is associated with).

Parameters
type:CollectionType

Type of collection instances to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

elementTypeDeserializer:TypeDeserializer

If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.

elementDeserializer:ValueDeserializer<?>

Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findCollectionLikeDeserializerback to summary
public default ValueDeserializer<?> findCollectionLikeDeserializer(CollectionLikeType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)

Method called to locate deserializer for specified "Collection-like" type (one that acts like java.util.Collection but does not implement it).

Deserializer for element type may be passed, if configured explicitly at higher level (by annotations, typically), but usually are not. Type deserializer for element is passed if one is needed based on contextual information (annotations on declared element class; or on field or method type is associated with).

Parameters
type:CollectionLikeType

Type of instances to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

elementTypeDeserializer:TypeDeserializer

If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.

elementDeserializer:ValueDeserializer<?>

Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findEnumDeserializerback to summary
public default ValueDeserializer<?> findEnumDeserializer(JavaType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef)

Method called to locate deserializer for specified java.lang.Enum type.

Parameters
type:JavaType

Type of java.lang.Enum instances to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findMapDeserializerback to summary
public default ValueDeserializer<?> findMapDeserializer(MapType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)

Method called to locate deserializer for specified java.util.Map type.

Deserializer for element type may be passed, if configured explicitly at higher level (by annotations, typically), but usually are not. Type deserializer for element is passed if one is needed based on contextual information (annotations on declared element class; or on field or method type is associated with).

Similarly, a KeyDeserializer may be passed, but this is only done if there is a specific configuration override (annotations) to indicate instance to use. Otherwise null is passed, and key deserializer needs to be obtained later during resolution of map serializer constructed here.

Parameters
type:MapType

Type of java.util.Map instances to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

keyDeserializer:KeyDeserializer

Key deserializer use, if it is defined via annotations or other configuration; null if default key deserializer for key type can be used.

elementTypeDeserializer:TypeDeserializer

If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.

elementDeserializer:ValueDeserializer<?>

Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findMapLikeDeserializerback to summary
public default ValueDeserializer<?> findMapLikeDeserializer(MapLikeType type, DeserializationConfig config, BeanDescription.Supplier beanDescRef, KeyDeserializer keyDeserializer, TypeDeserializer elementTypeDeserializer, ValueDeserializer<?> elementDeserializer)

Method called to locate deserializer for specified "Map-like" type (one that acts like java.util.Map but does not implement it).

Deserializer for element type may be passed, if configured explicitly at higher level (by annotations, typically), but usually are not. Type deserializer for element is passed if one is needed based on contextual information (annotations on declared element class; or on field or method type is associated with).

Similarly, a KeyDeserializer may be passed, but this is only done if there is a specific configuration override (annotations) to indicate instance to use. Otherwise null is passed, and key deserializer needs to be obtained later during resolution, by deserializer constructed here.

Parameters
type:MapLikeType

Type of java.util.Map instances to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the enumeration type that contains class annotations and other information typically needed for building deserializers

keyDeserializer:KeyDeserializer

Key deserializer use, if it is defined via annotations or other configuration; null if default key deserializer for key type can be used.

elementTypeDeserializer:TypeDeserializer

If element type needs polymorphic type handling, this is the type information deserializer to use; should usually be used as is when constructing array deserializer.

elementDeserializer:ValueDeserializer<?>

Deserializer to use for elements, if explicitly defined (by using annotations, for example). May be null, in which case it will need to be resolved by deserializer at a later point.

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findReferenceDeserializerback to summary
public default ValueDeserializer<?> findReferenceDeserializer(ReferenceType refType, DeserializationConfig config, BeanDescription.Supplier beanDescRef, TypeDeserializer contentTypeDeserializer, ValueDeserializer<?> contentDeserializer)

Method called to locate deserializer for value that is of referential type,

Parameters
refType:ReferenceType

Specific referential type to deserialize

config:DeserializationConfig

Configuration in effect

beanDescRef:BeanDescription.Supplier

Definition of the reference type that contains class annotations and other information typically needed for building deserializers

contentTypeDeserializer:TypeDeserializer

Possible type deserializer for referenced value

contentDeserializer:ValueDeserializer<?>

Value deserializer to use for referenced value, if indicated by property annotation

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

findTreeNodeDeserializerback to summary
public default ValueDeserializer<?> findTreeNodeDeserializer(JavaType nodeType, DeserializationConfig config, BeanDescription.Supplier beanDescRef)

Method called to locate deserializer for specified JSON tree node type.

Parameters
nodeType:JavaType

Specific type of JSON tree nodes to deserialize (subtype of TreeNode)

config:DeserializationConfig

Configuration in effect

Returns:ValueDeserializer<?>

Deserializer to use for the type; or null if this provider does not know how to construct it

hasDeserializerForback to summary
public boolean hasDeserializerFor(DeserializationConfig config, Class<?> valueType)

Method that may be called to check whether this deserializer provider would provide deserializer for values of given type, without attempting to construct (and possibly fail in some cases) actual deserializer. Mostly needed to support validation of polymorphic type ids.

Note

implementations should take care NOT to claim supporting types that they do not recognize as this could to incorrect assumption of safe support by caller.

Since
3.0
tools.jackson.databind.deser back to summary

public abstract Class Deserializers.Base

extends Object
implements Deserializers
Class Inheritance
All Implemented Interfaces
tools.jackson.databind.deser.Deserializers
Known Direct Subclasses
tools.jackson.databind.module.SimpleDeserializers

Basic Deserializers implementation that implements all methods but provides no deserializers. Its main purpose is to serve as a base class so that sub-classes only need to override methods they need, as most of the time some of methods are not needed (especially enumeration and array deserializers are very rarely overridden).

Constructor Summary

AccessConstructor and Description
public
Base()

Method Summary

Modifier and TypeMethod and Description
public abstract boolean
hasDeserializerFor(DeserializationConfig config, Class<?> valueType)

Redeclares tools.jackson.databind.deser.Deserializers.hasDeserializerFor.

Method that may be called to check whether this deserializer provider would provide deserializer for values of given type, without attempting to construct (and possibly fail in some cases) actual deserializer.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Baseback to summary
public Base()

Method Detail

hasDeserializerForback to summary
public abstract boolean hasDeserializerFor(DeserializationConfig config, Class<?> valueType)

Redeclares tools.jackson.databind.deser.Deserializers.hasDeserializerFor.

Doc from tools.jackson.databind.deser.Deserializers.hasDeserializerFor.

Method that may be called to check whether this deserializer provider would provide deserializer for values of given type, without attempting to construct (and possibly fail in some cases) actual deserializer. Mostly needed to support validation of polymorphic type ids.

Note

implementations should take care NOT to claim supporting types that they do not recognize as this could to incorrect assumption of safe support by caller.

Annotations
@Override