Package com.fasterxml.jackson.databind.deser.std

Class MapDeserializer

    • Method Detail

      • setIgnorableProperties

        @Deprecated
public void setIgnorableProperties​(java.lang.String[] ignorable)
        Deprecated.
        in 2.12, remove from 3.0

      • setIgnorableProperties

        public void setIgnorableProperties​(java.util.Set<java.lang.String> ignorable)

      • setIncludableProperties

        public void setIncludableProperties​(java.util.Set<java.lang.String> includable)

      • resolve

        public void resolve​(DeserializationContext ctxt)
             throws JsonMappingException
        Description copied from interface: ResolvableDeserializer
        Method called after deserializer instance has been constructed (and registered as necessary by provider objects), but before it has returned it to the caller. Called object can then resolve its dependencies to other types, including self-references (direct or indirect).
        Specified by:
        resolve in interface ResolvableDeserializer
        Parameters:
        ctxt - Context to use for accessing configuration, resolving secondary deserializers
        Throws:
        JsonMappingException

      • createContextual

        public JsonDeserializer<?> createContextual​(DeserializationContext ctxt,
                                            BeanProperty property)
                                     throws JsonMappingException
        Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.
        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 cannot 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

      • isCachable

        public boolean isCachable()
        Turns out that these are expensive enough to create so that caching does make sense.

        IMPORTANT: but, note, that instances CAN NOT BE CACHED if there is a value type deserializer; this caused an issue with 2.4.4 of JAXB Annotations (failing a test). It is also possible that some other settings could make deserializers un-cacheable; but on the other hand, caching can make a big positive difference with performance... so it's a hard choice.

        Overrides:
        isCachable in class JsonDeserializer<java.util.Map<java.lang.Object,​java.lang.Object>>
        Since:
        2.4.4

      • logicalType

        public LogicalType logicalType()
        Description copied from class: JsonDeserializer
        Method for accessing logical type of values this deserializer produces. Typically used for further configuring handling of values, for example, to find which coercions are legal.
        Overrides:
        logicalType in class JsonDeserializer<java.util.Map<java.lang.Object,​java.lang.Object>>
        Returns:
        Logical type of values this deserializer produces, if known; null if not

      • deserialize

        public java.util.Map<java.lang.Object,​java.lang.Object> deserialize​(JsonParser p,
                                                                          DeserializationContext ctxt)
                                                                   throws java.io.IOException
        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 or a FIELD_NAME.

        The two possible input conditions for structured types result from polymorphism via fields. In the ordinary case, Jackson calls this method when it has encountered an OBJECT_START, and the method implementation must advance to the next token to see the first field name. If the application configures polymorphism via a field, then the object looks like the following. 

              {
          "@class": "class name",
          ...
      }
        Jackson consumes the two tokens (the @class field name and its value) in order to learn the class and select the deserializer. Thus, the stream is pointing to the FIELD_NAME for the first field after the @class. Thus, if you want your method to work correctly both with and without polymorphism, you must begin your method with: 
               if (p.currentToken() == JsonToken.START_OBJECT) {
         p.nextToken();
       }
        This results in the stream pointing to the field name, so that the two conditions align.

        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<java.util.Map<java.lang.Object,​java.lang.Object>>
        Parameters:
        p - Parsed used for reading JSON content
        ctxt - Context that can be used to access information about this deserialization activity.
        Returns:
        Deserialized value
        Throws:
        java.io.IOException

      • deserialize

        public java.util.Map<java.lang.Object,​java.lang.Object> deserialize​(JsonParser p,
                                                                          DeserializationContext ctxt,
                                                                          java.util.Map<java.lang.Object,​java.lang.Object> result)
                                                                   throws java.io.IOException
        Description copied from class: JsonDeserializer
        Alternate deserialization method (compared to the most commonly used, JsonDeserializer.deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer. Method is not necessarily used (or supported) by all types (it will not work for immutable types, for obvious reasons): most commonly it is used for Collections and Maps. It may be used both with "updating readers" (for POJOs) and when Collections and Maps use "getter as setter".

        Default implementation just throws UnsupportedOperationException, to indicate that types that do not explicitly add support do not necessarily support update-existing-value operation (esp. immutable types)

        Overrides:
        deserialize in class JsonDeserializer<java.util.Map<java.lang.Object,​java.lang.Object>>
        Throws:
        java.io.IOException

      • deserializeWithType

        public java.lang.Object deserializeWithType​(JsonParser p,
                                            DeserializationContext ctxt,
                                            TypeDeserializer typeDeserializer)
                                     throws java.io.IOException
        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<java.util.Map<java.lang.Object,​java.lang.Object>>
        typeDeserializer - Deserializer to use for handling type information
        Throws:
        java.io.IOException

      • getMapClass

        public final java.lang.Class<?> getMapClass()

      • _deserializeUsingCreator

        public java.util.Map<java.lang.Object,​java.lang.Object> _deserializeUsingCreator​(JsonParser p,
                                                                                       DeserializationContext ctxt)
                                                                                throws java.io.IOException
        Throws:
        java.io.IOException