Package com.fasterxml.jackson.databind.deser.impl

Class BeanAsArrayDeserializer

java.lang.Object
com.fasterxml.jackson.databind.JsonDeserializer<Object>
com.fasterxml.jackson.databind.deser.std.StdDeserializer<Object>
com.fasterxml.jackson.databind.deser.BeanDeserializerBase
com.fasterxml.jackson.databind.deser.impl.BeanAsArrayDeserializer
All Implemented Interfaces:
ContextualDeserializer, NullValueProvider, ResolvableDeserializer, ValueInstantiator.Gettable, Serializable
public class BeanAsArrayDeserializer extends BeanDeserializerBase
Variant of BeanDeserializer used for handling deserialization of POJOs when serialized as JSON Arrays, instead of JSON Objects.
Since:
2.1
See Also:

  • Constructor Details

    • BeanAsArrayDeserializer

      public BeanAsArrayDeserializer(BeanDeserializerBase delegate, SettableBeanProperty[] ordered)
      Main constructor used both for creating new instances (by BeanDeserializer.asArrayDeserializer()) and for creating copies with different delegate.

  • Method Details

    • unwrappingDeserializer

      public JsonDeserializer<Object> unwrappingDeserializer(NameTransformer unwrapper)
      Description copied from class: JsonDeserializer
      Method that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.

      Default implementation just returns 'this' indicating that no unwrapped variant exists

      Specified by:
      unwrappingDeserializer in class BeanDeserializerBase

    • withObjectIdReader

      public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)
      Specified by:
      withObjectIdReader in class BeanDeserializerBase

    • withByNameInclusion

      public BeanDeserializerBase withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps)
      Specified by:
      withByNameInclusion in class BeanDeserializerBase

    • withIgnoreAllUnknown

      public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown)
      Specified by:
      withIgnoreAllUnknown in class BeanDeserializerBase

    • withBeanProperties

      public BeanDeserializerBase withBeanProperties(BeanPropertyMap props)
      Description copied from class: BeanDeserializerBase
      Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.
      Overrides:
      withBeanProperties in class BeanDeserializerBase

    • 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).

      Handling null values (JsonToken.VALUE_NULL)
      : Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the JsonDeserializer.getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override JsonDeserializer.getNullValue(DeserializationContext) and usually also JsonDeserializer.getNullAccessPattern().

      Specified by:
      deserialize in class JsonDeserializer<Object>
      Parameters:
      p - Parser used for reading JSON content
      ctxt - Context that can be used to access information about this deserialization activity.
      Returns:
      Deserialized value
      Throws:
      IOException

    • deserialize

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

    • deserializeFromObject

      public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException
      Description copied from class: BeanDeserializerBase
      General version used when handling needs more advanced features.
      Specified by:
      deserializeFromObject in class BeanDeserializerBase
      Throws:
      IOException