Package org.codehaus.jackson.map

Class TypeDeserializer

  • Direct Known Subclasses:
    TypeDeserializerBase
    public abstract class TypeDeserializer
extends java.lang.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.

    Since:
    1.5
    Author:
    tatus

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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

      • 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 java.lang.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 java.lang.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)
        Since:
        1.9

      • deserializeTypedFromObject

        public abstract java.lang.Object deserializeTypedFromObject​(JsonParser jp,
                                                            DeserializationContext ctxt)
                                                     throws java.io.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:
        java.io.IOException
        JsonProcessingException

      • deserializeTypedFromArray

        public abstract java.lang.Object deserializeTypedFromArray​(JsonParser jp,
                                                           DeserializationContext ctxt)
                                                    throws java.io.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:
        java.io.IOException
        JsonProcessingException

      • deserializeTypedFromScalar

        public abstract java.lang.Object deserializeTypedFromScalar​(JsonParser jp,
                                                            DeserializationContext ctxt)
                                                     throws java.io.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:
        java.io.IOException
        JsonProcessingException

      • deserializeTypedFromAny

        public abstract java.lang.Object deserializeTypedFromAny​(JsonParser jp,
                                                         DeserializationContext ctxt)
                                                  throws java.io.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:
        java.io.IOException
        JsonProcessingException