com.fasterxml.jackson.databind.jsontype

Class TypeDeserializer

java.lang.Object

com.fasterxml.jackson.databind.jsontype.TypeDeserializer

Direct Known Subclasses:

TypeDeserializerBase

public abstract class TypeDeserializer
extends Object

Interface for deserializing type information from JSON content, to type-safely deserialize data into correct polymorphic instance (when type inclusion has been enabled for type handled).

Separate deserialization methods are needed because serialized form for inclusion mechanism JsonTypeInfo.As.PROPERTY is slighty different if value is not expressed as JSON Object: and as such both type deserializer and serializer need to JSON Object form (array, object or other (== scalar)) being used.

Constructor Summary

Constructors

Constructor and Description
TypeDeserializer()

Method Summary

Methods

Modifier and Type	Method and Description
static Object	deserializeIfNatural(JsonParser jp, DeserializationContext ctxt, Class<?> base)
static Object	deserializeIfNatural(JsonParser jp, DeserializationContext ctxt, JavaType baseType) Helper method used to check if given parser might be pointing to a "natural" value, and one that would be acceptable as the result value (compatible with declared base type)
abstract Object	deserializeTypedFromAny(JsonParser jp, DeserializationContext ctxt) Method called to let this type deserializer handle deserialization of "typed" object, when value itself may have been serialized using any kind of JSON value (Array, Object, scalar).
abstract Object	deserializeTypedFromArray(JsonParser jp, DeserializationContext ctxt) Method called to let this type deserializer handle deserialization of "typed" object, when value itself is serialized as JSON Array (regardless of Java type).
abstract Object	deserializeTypedFromObject(JsonParser jp, DeserializationContext ctxt) Method called to let this type deserializer handle deserialization of "typed" object, when value itself is serialized as JSON Object (regardless of Java type).
abstract Object	deserializeTypedFromScalar(JsonParser jp, DeserializationContext ctxt) Method called to let this type deserializer handle deserialization of "typed" object, when value itself is serialized as a scalar JSON value (something other than Array or Object), regardless of Java type.
abstract TypeDeserializer	forProperty(BeanProperty prop) Method called to create contextual version, to be used for values of given property.
abstract Class<?>	getDefaultImpl() Accessor for "default implementation" type; optionally defined class to use in cases where type id is not accessible for some reason (either missing, or can not be resolved)
abstract String	getPropertyName() Name of property that contains type information, if property-based inclusion is used.
abstract TypeIdResolver	getTypeIdResolver() Accessor for object that handles conversions between types and matching type ids.
abstract JsonTypeInfo.As	getTypeInclusion() Accessor for type information inclusion method that deserializer uses; indicates how type information is (expected to be) embedded in JSON input.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeDeserializer

public TypeDeserializer()

Method Detail

forProperty

public abstract TypeDeserializer forProperty(BeanProperty prop)

Method called to create contextual version, to be used for values of given property. This may be the type itself (as is the case for bean properties), or values contained (for Collection or Map valued properties).

Since:

2.0

getTypeInclusion

public abstract JsonTypeInfo.As getTypeInclusion()

Accessor for type information inclusion method that deserializer uses; indicates how type information is (expected to be) embedded in JSON input.

getPropertyName

public abstract String getPropertyName()

Name of property that contains type information, if property-based inclusion is used.

getTypeIdResolver

public abstract TypeIdResolver getTypeIdResolver()

Accessor for object that handles conversions between types and matching type ids.

getDefaultImpl

public abstract Class<?> getDefaultImpl()

Accessor for "default implementation" type; optionally defined class to use in cases where type id is not accessible for some reason (either missing, or can not be resolved)

deserializeTypedFromObject

public abstract Object deserializeTypedFromObject(JsonParser jp,
                                DeserializationContext ctxt)
                                           throws IOException,
                                                  JsonProcessingException

Method called to let this type deserializer handle deserialization of "typed" object, when value itself is serialized as JSON Object (regardless of Java type). Method needs to figure out intended polymorphic type, locate JsonDeserializer to use, and call it with JSON data to deserializer (which does not contain type information).

Throws:

IOException

JsonProcessingException

deserializeTypedFromArray

public abstract Object deserializeTypedFromArray(JsonParser jp,
                               DeserializationContext ctxt)
                                          throws IOException,
                                                 JsonProcessingException

Method called to let this type deserializer handle deserialization of "typed" object, when value itself is serialized as JSON Array (regardless of Java type). Method needs to figure out intended polymorphic type, locate JsonDeserializer to use, and call it with JSON data to deserializer (which does not contain type information).

Throws:

IOException

JsonProcessingException

deserializeTypedFromScalar

public abstract Object deserializeTypedFromScalar(JsonParser jp,
                                DeserializationContext ctxt)
                                           throws IOException,
                                                  JsonProcessingException

Method called to let this type deserializer handle deserialization of "typed" object, when value itself is serialized as a scalar JSON value (something other than Array or Object), regardless of Java type. Method needs to figure out intended polymorphic type, locate JsonDeserializer to use, and call it with JSON data to deserializer (which does not contain type information).

Throws:

IOException

JsonProcessingException

deserializeTypedFromAny

public abstract Object deserializeTypedFromAny(JsonParser jp,
                             DeserializationContext ctxt)
                                        throws IOException,
                                               JsonProcessingException

Method called to let this type deserializer handle deserialization of "typed" object, when value itself may have been serialized using any kind of JSON value (Array, Object, scalar). Should only be called if JSON serialization is polymorphic (not Java type); for example when using JSON node representation, or "untyped" Java object (which may be Map, Collection, wrapper/primitive etc).

Throws:

IOException

JsonProcessingException

deserializeIfNatural

public static Object deserializeIfNatural(JsonParser jp,
                          DeserializationContext ctxt,
                          JavaType baseType)
                                   throws IOException,
                                          JsonProcessingException

Helper method used to check if given parser might be pointing to a "natural" value, and one that would be acceptable as the result value (compatible with declared base type)

Throws:

IOException

JsonProcessingException

deserializeIfNatural

public static Object deserializeIfNatural(JsonParser jp,
                          DeserializationContext ctxt,
                          Class<?> base)
                                   throws IOException,
                                          JsonProcessingException

Throws:

IOException

JsonProcessingException