com.fasterxml.jackson.databind.deser.std

Class EnumDeserializer

    • Field Detail

      • _enumsByIndex

        protected Object[] _enumsByIndex

      • _lookupByToString

        protected CompactStringObjectMap _lookupByToString
        Alternatively, we may need a different lookup object if "use toString" is defined.
        Since:
        2.7.3

      • _caseInsensitive

        protected final Boolean _caseInsensitive

      • _isFromIntValue

        protected final boolean _isFromIntValue
        Marker flag for cases where we expect actual integral value for Enum, based on @JsonValue (and equivalent) annotated accessor.
        Since:
        2.13

    • Method Detail

      • deserializerForNoArgsCreator

        public static JsonDeserializer<?> deserializerForNoArgsCreator(DeserializationConfig config,
                                                               Class<?> enumClass,
                                                               AnnotatedMethod factory)
        Factory method used when Enum instances are to be deserialized using a zero-/no-args factory method
        Returns:
        Deserializer based on given no-args factory method
        Since:
        2.8

      • 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 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()
        Because of costs associated with constructing Enum resolvers, let's cache instances by default.
        Overrides:
        isCachable in class JsonDeserializer<Object>

      • 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 StdScalarDeserializer<Object>
        Returns:
        Logical type of values this deserializer produces, if known; null if not

      • deserialize

        public Object deserialize(JsonParser p,
                          DeserializationContext ctxt)
                   throws 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<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:
        IOException

      • _enumClass

        protected Class<?> _enumClass()

Copyright © 2008–2022 FasterXML. All rights reserved.