Top Description Inners Fields Constructors Methods
tools.jackson.databind.deser.jdk

public Class CollectionDeserializer

extends ContainerDeserializerBase<Collection<Object>>
Class Inheritance
Known Direct Subclasses
tools.jackson.databind.deser.jdk.ArrayBlockingQueueDeserializer
Annotations
@JacksonStdImpl
Imports
java.util.*, .Objects, com.fasterxml.jackson.annotation.JsonFormat, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.annotation.JacksonStdImpl, tools.jackson.databind.cfg.CoercionAction, .CoercionInputShape, tools.jackson.databind.deser.*, .ReadableObjectId.Referring, tools.jackson.databind.deser.std.ContainerDeserializerBase, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType, tools.jackson.databind.util.ClassUtil

Basic serializer that can take JSON "Array" structure and construct a java.util.Collection instance, with typed contents.

Note

for untyped content (one indicated by passing Object.class as the type), UntypedObjectDeserializer is used instead. It can also construct java.util.Lists, but not with specific POJO types, only other containers and primitives/wrappers.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
CollectionDeserializer.CollectionReferring

Helper class to maintain processing order of value.

public static class
CollectionDeserializer.CollectionReferringAccumulator

Helper class for dealing with Object Id references for values contained in collections being deserialized.

Field Summary

Modifier and TypeField and Description
protected final ValueDeserializer<Object>
_delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

protected final ValueDeserializer<Object>
_valueDeserializer

Value deserializer.

protected final ValueInstantiator
protected final TypeDeserializer
_valueTypeDeserializer

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

Inherited from tools.jackson.databind.deser.std.ContainerDeserializerBase:
_containerType_nullProvider_skipNullValues_unwrapSingle

Constructor Summary

AccessConstructor and Description
public
CollectionDeserializer(JavaType collectionType, ValueDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator)

Constructor for context-free instances, where we do not yet know which property is using this deserializer.

protected
CollectionDeserializer(JavaType collectionType, ValueDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator, ValueDeserializer<Object> delegateDeser, NullValueProvider nuller, Boolean unwrapSingle)

Constructor used when creating contextualized instances.

protected
CollectionDeserializer(CollectionDeserializer src)

Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.

Method Summary

Modifier and TypeMethod and Description
protected Collection<Object>
protected Collection<Object>
_deserializeFromString(JsonParser p, DeserializationContext ctxt, String value)

Logic extracted to deal with incoming String value.

protected Object
_deserializeNoNullChecks(JsonParser p, DeserializationContext ctxt)

Deserialize the content of the collection.

protected Collection<Object>
protected void
_tryToAddNull(JsonParser p, DeserializationContext ctxt, Collection<?> set)

java.util.TreeSet (and possibly other Collection types) does not allow addition of null values, so isolate handling here.

public CollectionDeserializer
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.

protected Collection<Object>
public Collection<Object>
deserialize(JsonParser p, DeserializationContext ctxt)

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

public Collection<Object>
deserialize(JsonParser p, DeserializationContext ctxt, Collection<Object> result)

Overrides tools.jackson.databind.ValueDeserializer.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.

public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

public ValueDeserializer<Object>
getContentDeserializer()

Implements abstract tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

public ValueInstantiator
protected final Collection<Object>
handleNonArray(JsonParser p, DeserializationContext ctxt, Collection<Object> result)

Helper method called when current token is no START_ARRAY.

public boolean
isCachable()

Overrides tools.jackson.databind.ValueDeserializer.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 tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

protected CollectionDeserializer
withResolved(ValueDeserializer<?> dd, ValueDeserializer<?> vd, TypeDeserializer vtd, NullValueProvider nuller, Boolean unwrapSingle)

Fluent-factory method call to construct contextual instance.

Inherited from tools.jackson.databind.deser.std.ContainerDeserializerBase:
findBackReferencegetContentTypegetEmptyAccessPatterngetEmptyValuegetValueTypesupportsUpdatewrapAndThrow

Field Detail

_delegateDeserializerback to summary
protected final ValueDeserializer<Object> _delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

_valueDeserializerback to summary
protected final ValueDeserializer<Object> _valueDeserializer

Value deserializer.

_valueInstantiatorback to summary
protected final ValueInstantiator _valueInstantiator
_valueTypeDeserializerback to summary
protected final TypeDeserializer _valueTypeDeserializer

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

Constructor Detail

CollectionDeserializerback to summary
public CollectionDeserializer(JavaType collectionType, ValueDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator)

Constructor for context-free instances, where we do not yet know which property is using this deserializer.

CollectionDeserializerback to summary
protected CollectionDeserializer(JavaType collectionType, ValueDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator, ValueDeserializer<Object> delegateDeser, NullValueProvider nuller, Boolean unwrapSingle)

Constructor used when creating contextualized instances.

CollectionDeserializerback to summary
protected CollectionDeserializer(CollectionDeserializer src)

Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.

Method Detail

_deserializeFromArrayback to summary
protected Collection<Object> _deserializeFromArray(JsonParser p, DeserializationContext ctxt, Collection<Object> result) throws JacksonException
Since
2.12
_deserializeFromStringback to summary
protected Collection<Object> _deserializeFromString(JsonParser p, DeserializationContext ctxt, String value) throws JacksonException

Logic extracted to deal with incoming String value.

Annotations
@SuppressWarnings:unchecked
Since
2.12
_deserializeNoNullChecksback to summary
protected Object _deserializeNoNullChecks(JsonParser p, DeserializationContext ctxt)

Deserialize the content of the collection. If _valueTypeDeserializer is null, use _valueDeserializer.deserialize; if non-null, use _valueDeserializer.deserializeWithType to deserialize value. This method only performs deserialization and does not consider _skipNullValues, _nullProvider, etc.

_deserializeWithObjectIdback to summary
protected Collection<Object> _deserializeWithObjectId(JsonParser p, DeserializationContext ctxt, Collection<Object> result) throws JacksonException
_tryToAddNullback to summary
protected void _tryToAddNull(JsonParser p, DeserializationContext ctxt, Collection<?> set)

java.util.TreeSet (and possibly other Collection types) does not allow addition of null values, so isolate handling here.

createContextualback to summary
public CollectionDeserializer createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.

Annotations
@Override
createDefaultInstanceback to summary
protected Collection<Object> createDefaultInstance(DeserializationContext ctxt) throws JacksonException
Annotations
@SuppressWarnings:unchecked
deserializeback to summary
public Collection<Object> deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.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).

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 ValueDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override ValueDeserializer#getNullValue(DeserializationContext) and usually also ValueDeserializer#getNullAccessPattern().

Annotations
@SuppressWarnings:unchecked
@Override
deserializeback to summary
public Collection<Object> deserialize(JsonParser p, DeserializationContext ctxt, Collection<Object> result) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.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
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws JacksonException

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Doc from tools.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.

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

Implements abstract tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Doc from tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

Annotations
@Override
getValueInstantiatorback to summary
public ValueInstantiator getValueInstantiator()

Overrides tools.jackson.databind.deser.std.StdDeserializer.getValueInstantiator.

Implements tools.jackson.databind.deser.ValueInstantiator.Gettable.getValueInstantiator.

Annotations
@Override
handleNonArrayback to summary
protected final Collection<Object> handleNonArray(JsonParser p, DeserializationContext ctxt, Collection<Object> result) throws JacksonException

Helper method called when current token is no START_ARRAY. Will either throw an exception, or try to handle value as if member of implicit array, depending on configuration.

Annotations
@SuppressWarnings:unchecked
isCachableback to summary
public boolean isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

Doc from tools.jackson.databind.ValueDeserializer.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 contextualized on per-property basis (but note that ValueDeserializer#resolve(DeserializationContext)d just once!) 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 tools.jackson.databind.ValueDeserializer.logicalType.

Doc from tools.jackson.databind.ValueDeserializer.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.

Annotations
@Override
withResolvedback to summary
protected CollectionDeserializer withResolved(ValueDeserializer<?> dd, ValueDeserializer<?> vd, TypeDeserializer vtd, NullValueProvider nuller, Boolean unwrapSingle)

Fluent-factory method call to construct contextual instance.

Annotations
@SuppressWarnings:unchecked
tools.jackson.databind.deser.jdk back to summary

private final Class CollectionDeserializer.CollectionReferring

extends Referring
Class Inheritance

Helper class to maintain processing order of value. The resolved object associated with #id parameter from handleResolvedForwardReference(Object, Object) comes before the values in next.

Field Summary

Modifier and TypeField and Description
private final CollectionDeserializer.CollectionReferringAccumulator
public final List<Object>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
Inherited from tools.jackson.databind.deser.ReadableObjectId.Referring:
getBeanTypegetLocationhasId

Field Detail

_parentback to summary
private final CollectionDeserializer.CollectionReferringAccumulator _parent
nextback to summary
public final List<Object> next

Constructor Detail

CollectionReferringback to summary
pack-priv CollectionReferring(CollectionDeserializer.CollectionReferringAccumulator parent, UnresolvedForwardReference reference, Class<?> contentType)

Method Detail

handleResolvedForwardReferenceback to summary
public void handleResolvedForwardReference(DeserializationContext ctxt, Object id, Object value) throws JacksonException

Implements abstract tools.jackson.databind.deser.ReadableObjectId.Referring.handleResolvedForwardReference.

Annotations
@Override
tools.jackson.databind.deser.jdk back to summary

public Class CollectionDeserializer.CollectionReferringAccumulator

extends Object
Class Inheritance
  • java.lang.Object
  • tools.jackson.databind.deser.jdk.CollectionDeserializer.CollectionReferringAccumulator

Helper class for dealing with Object Id references for values contained in collections being deserialized.

Field Summary

Modifier and TypeField and Description
private List<CollectionDeserializer.CollectionReferring>
_accumulator

A list of CollectionReferring to maintain ordering.

private final Class<?>
private final Collection<Object>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
add(Object value)

public ReadableObjectId.Referring
public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_accumulatorback to summary
private List<CollectionDeserializer.CollectionReferring> _accumulator

A list of CollectionReferring to maintain ordering.

_elementTypeback to summary
private final Class<?> _elementType
_resultback to summary
private final Collection<Object> _result

Constructor Detail

CollectionReferringAccumulatorback to summary
public CollectionReferringAccumulator(Class<?> elementType, Collection<Object> result)

Method Detail

addback to summary
public void add(Object value)
handleUnresolvedReferenceback to summary
public ReadableObjectId.Referring handleUnresolvedReference(UnresolvedForwardReference reference)
resolveForwardReferenceback to summary
public void resolveForwardReference(DeserializationContext ctxt, Object id, Object value) throws JacksonException