com.fasterxml.jackson.databind.deser.std
Class StdDelegatingDeserializer<T>

java.lang.Object
  com.fasterxml.jackson.databind.JsonDeserializer<T>
      com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>
          com.fasterxml.jackson.databind.deser.std.StdDelegatingDeserializer<T>

Type Parameters:

T - Target type to convert to, from delegate type

All Implemented Interfaces:

ContextualDeserializer, Serializable

public class StdDelegatingDeserializer<T>
extends StdDeserializer<T>
implements ContextualDeserializer

Deserializer implementation where given Java type is first deserialized by a standard Jackson deserializer into a delegate type; and then this delegate type is converted using a configured Converter into desired target type. Common delegate types to use are Map and JsonNode.

Note that although types (delegate, target) may be related, they must not be same; trying to do this will result in an exception.

Since:

2.1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

JsonDeserializer.None

Field Summary

protected Converter<Object,T>	_converter
protected JsonDeserializer<Object>	_delegateDeserializer Underlying serializer for type T<.code>.
protected JavaType	_delegateType Fully resolved delegate type, with generic information if any available.

Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

_valueClass

Constructor Summary

	StdDelegatingDeserializer(Converter<?,T> converter)
protected	StdDelegatingDeserializer(Converter<Object,T> converter, JavaType delegateType, JsonDeserializer<?> delegateDeserializer)

Method Summary

protected T	convertValue(Object delegateValue) Method called to convert from "delegate value" (which was deserialized from JSON using standard Jackson deserializer for delegate type) into desired target type.
JsonDeserializer<?>	createContextual(DeserializationContext ctxt, BeanProperty property) Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
T	deserialize(JsonParser jp, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
Object	deserializeWithType(JsonParser jp, DeserializationContext ctxt, TypeDeserializer typeDeserializer) Base implementation that does not assume specific type inclusion mechanism.
JsonDeserializer<?>	getDelegatee() Accessor that can be used to determine if this deserializer uses another deserializer for actual deserialization, by delegating calls.
protected StdDelegatingDeserializer<T>	withDelegate(Converter<Object,T> converter, JavaType delegateType, JsonDeserializer<?> delegateDeserializer) Method used for creating resolved contextual instances.

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

_parseBoolean, _parseBooleanFromNumber, _parseBooleanPrimitive, _parseByte, _parseDate, _parseDouble, _parseDoublePrimitive, _parseFloat, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseShort, _parseShortPrimitive, _parseString, findDeserializer, getValueClass, getValueType, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

deserialize, getEmptyValue, getKnownPropertyNames, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object

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

Field Detail

_converter

protected final Converter<Object,T> _converter

_delegateType

protected final JavaType _delegateType

Fully resolved delegate type, with generic information if any available.

_delegateDeserializer

protected final JsonDeserializer<Object> _delegateDeserializer

Underlying serializer for type T<.code>.

Constructor Detail

StdDelegatingDeserializer

public StdDelegatingDeserializer(Converter<?,T> converter)

StdDelegatingDeserializer

protected StdDelegatingDeserializer(Converter<Object,T> converter,
                                    JavaType delegateType,
                                    JsonDeserializer<?> delegateDeserializer)

Method Detail

withDelegate

protected StdDelegatingDeserializer<T> withDelegate(Converter<Object,T> converter,
                                                    JavaType delegateType,
                                                    JsonDeserializer<?> delegateDeserializer)

Method used for creating resolved contextual instances. Must be overridden when sub-classing.

createContextual

public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
                                            BeanProperty property)
                                     throws JsonMappingException

Description copied from interface: ContextualDeserializer

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Specified by:

createContextual in interface ContextualDeserializer

Parameters:

ctxt - Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property - Method, field or constructor parameter that represents the property (and is used to assign deserialized value). Should be available; but there may be cases where caller can not provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)

Returns:

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Throws:

JsonMappingException

getDelegatee

public JsonDeserializer<?> getDelegatee()

Description copied from class: JsonDeserializer

Accessor that can be used to determine if this deserializer uses another deserializer for actual deserialization, by delegating calls. If so, will return immediate delegate (which itself may delegate to further deserializers); otherwise will return null.

Overrides:

getDelegatee in class JsonDeserializer<T>

Returns:

Deserializer this deserializer delegates calls to, if null; null otherwise.

deserialize

public T deserialize(JsonParser jp,
                     DeserializationContext ctxt)
              throws IOException,
                     JsonProcessingException

Description copied from class: JsonDeserializer

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. Returned instance is to be constructed by method itself.

Pre-condition for this method is that the parser points to the first event that is part of value to deserializer (and which is never JSON 'null' literal, more on this below): for simple types it may be the only value; and for structured types the Object start marker. Post-condition is that the parser will point to the last event that is part of deserialized value (or in case deserialization fails, event that was not recognized or usable, which may be the same event as the one it pointed to upon call).

Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.

Specified by:

deserialize in class JsonDeserializer<T>

Parameters:

jp - Parsed used for reading JSON content

ctxt - Context that can be used to access information about this deserialization activity.

Returns:

Deserializer value

Throws:

IOException

JsonProcessingException

deserializeWithType

public Object deserializeWithType(JsonParser jp,
                                  DeserializationContext ctxt,
                                  TypeDeserializer typeDeserializer)
                           throws IOException,
                                  JsonProcessingException

Description copied from class: StdDeserializer

Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Overrides:

deserializeWithType in class StdDeserializer<T>

typeDeserializer - Deserializer to use for handling type information

Throws:

IOException

JsonProcessingException

convertValue

protected T convertValue(Object delegateValue)

Method called to convert from "delegate value" (which was deserialized from JSON using standard Jackson deserializer for delegate type) into desired target type.

The default implementation uses configured Converter to do conversion.

Parameters:

delegateValue -

Returns:

Result of conversion