com.fasterxml.jackson.databind.deser.std

Class ObjectArrayDeserializer

java.lang.Object

com.fasterxml.jackson.databind.JsonDeserializer<T>

com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>

com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase<java.lang.Object[]>

com.fasterxml.jackson.databind.deser.std.ObjectArrayDeserializer

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, ValueInstantiator.Gettable, java.io.Serializable

public class ObjectArrayDeserializer
extends ContainerDeserializerBase<java.lang.Object[]>
implements ContextualDeserializer

Basic serializer that can serialize non-primitive arrays.

See Also:

Serialized Form

Nested Class Summary

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

JsonDeserializer.None

Constructor Summary

Constructors

Constructor and Description
ObjectArrayDeserializer(JavaType arrayType, JsonDeserializer<java.lang.Object> elemDeser, TypeDeserializer elemTypeDeser)

Method Summary

Modifier and Type	Method and Description
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.
java.lang.Object[]	deserialize(JsonParser p, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
java.lang.Object[]	deserialize(JsonParser p, DeserializationContext ctxt, java.lang.Object[] intoValue) 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.
java.lang.Object[]	deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) Base implementation that does not assume specific type inclusion mechanism.
JsonDeserializer<java.lang.Object>	getContentDeserializer() Accesor for deserializer use for deserializing content values.
AccessPattern	getEmptyAccessPattern() This method may be called in conjunction with calls to JsonDeserializer.getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.
java.lang.Object	getEmptyValue(DeserializationContext ctxt) Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).
boolean	isCachable() Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).
ObjectArrayDeserializer	withDeserializer(TypeDeserializer elemTypeDeser, JsonDeserializer<?> elemDeser) Overridable fluent-factory method used to create contextual instances
ObjectArrayDeserializer	withResolved(TypeDeserializer elemTypeDeser, JsonDeserializer<?> elemDeser, NullValueProvider nuller, java.lang.Boolean unwrapSingle)

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

findBackReference, getContentType, getValueInstantiator, getValueType, supportsUpdate

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

getValueClass, handledType

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

getDelegatee, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getNullValue, getNullValue, getObjectIdReader, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectArrayDeserializer

public ObjectArrayDeserializer(JavaType arrayType,
                               JsonDeserializer<java.lang.Object> elemDeser,
                               TypeDeserializer elemTypeDeser)

Method Detail

withDeserializer

public ObjectArrayDeserializer withDeserializer(TypeDeserializer elemTypeDeser,
                                                JsonDeserializer<?> elemDeser)

Overridable fluent-factory method used to create contextual instances

withResolved

public ObjectArrayDeserializer withResolved(TypeDeserializer elemTypeDeser,
                                            JsonDeserializer<?> elemDeser,
                                            NullValueProvider nuller,
                                            java.lang.Boolean unwrapSingle)

Since:

2.7

isCachable

public boolean isCachable()

Description copied from class: JsonDeserializer

Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).

Note that cached instances are still resolved on per-property basis, if instance implements ResolvableDeserializer: cached instance is just as the base. This means that in most cases it is safe to cache instances; however, it only makes sense to cache instances if instantiation is expensive, or if instances are heavy-weight.

Default implementation returns false, to indicate that no caching is done.

Overrides:

isCachable in class JsonDeserializer<java.lang.Object[]>

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

getContentDeserializer

public JsonDeserializer<java.lang.Object> getContentDeserializer()

Description copied from class: ContainerDeserializerBase

Accesor for deserializer use for deserializing content values.

Specified by:

getContentDeserializer in class ContainerDeserializerBase<java.lang.Object[]>

getEmptyAccessPattern

public AccessPattern getEmptyAccessPattern()

Description copied from class: JsonDeserializer

This method may be called in conjunction with calls to JsonDeserializer.getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.

Overrides:

getEmptyAccessPattern in class ContainerDeserializerBase<java.lang.Object[]>

getEmptyValue

public java.lang.Object getEmptyValue(DeserializationContext ctxt)
                               throws JsonMappingException

Description copied from class: JsonDeserializer

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) (which in turn is usually simply Java null), but it can be overridden for types. Or, if type should never be converted from empty String, method can also throw an exception.

Since version 2.6 (in which the context argument was added), call is expected to be made each and every time an empty value is needed.

Since version 2.9 does not require return of `T` any more.

Default implementation simply calls JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) and returns value.

Overrides:

getEmptyValue in class ContainerDeserializerBase<java.lang.Object[]>

Throws:

JsonMappingException

deserialize

public 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.getCurrentToken() == 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.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

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.lang.Object[]>

typeDeserializer - Deserializer to use for handling type information

Throws:

java.io.IOException

deserialize

public java.lang.Object[] deserialize(JsonParser p,
                                      DeserializationContext ctxt,
                                      java.lang.Object[] intoValue)
                               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.lang.Object[]>

Throws:

java.io.IOException