Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.deser.std

public Class ObjectArrayDeserializer

extends ContainerDeserializerBase<Object[]>
implements ContextualDeserializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.deser.ContextualDeserializer
Annotations
@JacksonStdImpl
Imports
java.io.IOException, java.lang.reflect.Array, java.util.Arrays, .Objects, com.fasterxml.jackson.annotation.JsonFormat, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.annotation.JacksonStdImpl, com.fasterxml.jackson.databind.cfg.CoercionAction, .CoercionInputShape, com.fasterxml.jackson.databind.deser.ContextualDeserializer, .NullValueProvider, com.fasterxml.jackson.databind.jsontype.TypeDeserializer, com.fasterxml.jackson.databind.type.ArrayType, .LogicalType, com.fasterxml.jackson.databind.util.AccessPattern, .ObjectBuffer

Serializer that can serialize non-primitive arrays.

Field Summary

Modifier and TypeField and Description
protected final Class<?>
_elementClass

Type of contained elements: needed for constructing actual result array

protected JsonDeserializer<Object>
_elementDeserializer

Element deserializer

protected final TypeDeserializer
_elementTypeDeserializer

If element instances have polymorphic type information, this is the type deserializer that can handle it

protected final Object[]
protected final boolean
_untyped

Flag that indicates whether the component type is Object or not.

private static final long
Inherited from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase:
_containerType_nullProvider_skipNullValues_unwrapSingle

Constructor Summary

AccessConstructor and Description
public
protected

Method Summary

Modifier and TypeMethod and Description
public JsonDeserializer<?>
createContextual(DeserializationContext
Deserialization context to access configuration, additional deserializers that may be needed by this deserializer
ctxt
,
BeanProperty
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)
property
)

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
public Object[]
deserialize(JsonParser
Parsed used for reading JSON content
p
,
DeserializationContext
Context that can be used to access information about this deserialization activity.
ctxt
)

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
public Object[]
deserialize(JsonParser p, DeserializationContext ctxt, Object[] intoValue)

Overrides com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.
protected Byte[]
public Object[]
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information
typeDeserializer
)

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.
public JsonDeserializer<Object>
getContentDeserializer()

Implements abstract com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.
public AccessPattern
getEmptyAccessPattern()

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyAccessPattern.

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

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).
protected Object[]
public boolean
isCachable()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.isCachable.

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

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.
public ObjectArrayDeserializer
withDeserializer(TypeDeserializer elemTypeDeser, JsonDeserializer<?> elemDeser)

Overridable fluent-factory method used to create contextual instances

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

Inherited from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase:
findBackReferencegetContentTypegetValueTypesupportsUpdatewrapAndThrowwrapAndThrow

Field Detail

_elementClassback to summary
protected final Class<?> _elementClass

Type of contained elements: needed for constructing actual result array

_elementDeserializerback to summary
protected JsonDeserializer<Object> _elementDeserializer

Element deserializer

_elementTypeDeserializerback to summary
protected final TypeDeserializer _elementTypeDeserializer

If element instances have polymorphic type information, this is the type deserializer that can handle it

_emptyValueback to summary
protected final Object[] _emptyValue
Since
2.12
_untypedback to summary
protected final boolean _untyped

Flag that indicates whether the component type is Object or not. Used for minor optimization when constructing result.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.deser.std.StdDeserializer.serialVersionUID.

Constructor Detail

ObjectArrayDeserializerback to summary
public ObjectArrayDeserializer(JavaType arrayType0, JsonDeserializer<Object> elemDeser, TypeDeserializer elemTypeDeser)
ObjectArrayDeserializerback to summary
protected ObjectArrayDeserializer(ObjectArrayDeserializer base, JsonDeserializer<Object> elemDeser, TypeDeserializer elemTypeDeser, NullValueProvider nuller, Boolean unwrapSingle)

Method Detail

createContextualback to summary
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

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.

Parameters
ctxt:DeserializationContext

Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property:BeanProperty

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:JsonDeserializer<?>

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Annotations
@Override
deserializeback to summary
public Object[] deserialize(JsonParser p, DeserializationContext ctxt) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

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.

Parameters
p:JsonParser

Parsed used for reading JSON content

ctxt:DeserializationContext

Context that can be used to access information about this deserialization activity.

Returns:Object[]

Deserialized value

Annotations
@Override
deserializeback to summary
public Object[] deserialize(JsonParser p, DeserializationContext ctxt, Object[] intoValue) throws IOException

Overrides com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, 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)

Annotations
@Override
deserializeFromBase64back to summary
protected Byte[] deserializeFromBase64(JsonParser p, DeserializationContext ctxt) throws IOException
deserializeWithTypeback to summary
public Object[] deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Doc from com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

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.

Parameters
typeDeserializer:TypeDeserializer

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType.

Deserializer to use for handling type information

Annotations
@Override
getContentDeserializerback to summary
public JsonDeserializer<Object> getContentDeserializer()

Implements abstract com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Doc from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

Annotations
@Override
getEmptyAccessPatternback to summary
public AccessPattern getEmptyAccessPattern()

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyAccessPattern.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.getEmptyAccessPattern.

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

Annotations
@Override
getEmptyValueback to summary
public Object getEmptyValue(DeserializationContext ctxt) throws JsonMappingException

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getEmptyValue.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.getEmptyValue.

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

This method may be called once, or multiple times, depending on what getEmptyAccessPattern() returns.

Default implementation simply calls getNullValue and returns value.

Annotations
@Override
handleNonArrayback to summary
protected Object[] handleNonArray(JsonParser p, DeserializationContext ctxt) throws IOException
isCachableback to summary
public boolean isCachable()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.isCachable.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.isCachable.

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 com.fasterxml.jackson.databind.deser.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.

Annotations
@Override
logicalTypeback to summary
public LogicalType logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

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.

Returns:LogicalType

Logical type of values this deserializer produces, if known; null if not

Annotations
@Override
withDeserializerback to summary
public ObjectArrayDeserializer withDeserializer(TypeDeserializer elemTypeDeser, JsonDeserializer<?> elemDeser)

Overridable fluent-factory method used to create contextual instances

withResolvedback to summary
public ObjectArrayDeserializer withResolved(TypeDeserializer elemTypeDeser, JsonDeserializer<?> elemDeser, NullValueProvider nuller, Boolean unwrapSingle)
Annotations
@SuppressWarnings:unchecked
Since
2.7