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.s, but not with specific
POJO types, only other containers and primitives/wrappers.
| Modifier and Type | Class and Description |
|---|---|
| private static class | CollectionDeserializer.
Helper class to maintain processing order of value. |
| public static class | CollectionDeserializer.
Helper class for dealing with Object Id references for values contained in collections being deserialized. |
| Modifier and Type | Field and Description |
|---|---|
| protected final JsonDeserializer | _delegateDeserializer
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object. |
| protected final JsonDeserializer | _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 |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | CollectionDeserializer(JavaType collectionType, JsonDeserializer<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, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator, JsonDeserializer<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. |
| Modifier and Type | Method and Description |
|---|---|
| protected Collection | |
| protected Collection | _deserializeFromString(JsonParser p, DeserializationContext ctxt, String value)
Logic extracted to deal with incoming String value. |
| protected Collection | |
| protected void | _tryToAddNull(JsonParser p, DeserializationContext ctxt, Collection<?> set)
|
| public CollectionDeserializer | 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. Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for. |
| protected Collection | |
| public Collection | deserialize(JsonParser
Parser used for reading JSON content p, DeserializationContext Context that can be used to access information about
this deserialization activity. ctxt)Implements abstract com. Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. |
| public Collection | deserialize(JsonParser p, DeserializationContext ctxt, Collection<Object> result)
Overrides com. Alternate deserialization method (compared to the most commonly
used, |
| public Object | deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information typeDeserializer)Overrides com. Base implementation that does not assume specific type inclusion mechanism. |
| public JsonDeserializer | getContentDeserializer()
Implements abstract com. Accesor for deserializer use for deserializing content values. |
| public ValueInstantiator | |
| protected final Collection | handleNonArray(JsonParser p, DeserializationContext ctxt, Collection<Object> result)
Helper method called when current token is no START_ARRAY. |
| public boolean | isCachable()
Overrides com. 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. Method for accessing logical type of values this deserializer produces. |
| protected CollectionDeserializer | withResolved(JsonDeserializer<?> dd, JsonDeserializer<?> vd, TypeDeserializer vtd, NullValueProvider nuller, Boolean unwrapSingle)
Fluent-factory method call to construct contextual instance. |
| _delegateDeserializer | back to summary |
|---|---|
| protected final JsonDeserializer<Object> _delegateDeserializer Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object. | |
| _valueDeserializer | back to summary |
|---|---|
| protected final JsonDeserializer<Object> _valueDeserializer Value deserializer. | |
| _valueInstantiator | back to summary |
|---|---|
| protected final ValueInstantiator _valueInstantiator | |
| _valueTypeDeserializer | back to summary |
|---|---|
| protected final TypeDeserializer _valueTypeDeserializer If element instances have polymorphic type information, this is the type deserializer that can handle it | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides com. | |
| CollectionDeserializer | back to summary |
|---|---|
| public CollectionDeserializer(JavaType collectionType, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator) Constructor for context-free instances, where we do not yet know which property is using this deserializer. | |
| CollectionDeserializer | back to summary |
|---|---|
| protected CollectionDeserializer(JavaType collectionType, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator, JsonDeserializer<Object> delegateDeser, NullValueProvider nuller, Boolean unwrapSingle) Constructor used when creating contextualized instances.
| |
| CollectionDeserializer | back 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. | |
| _deserializeFromArray | back to summary |
|---|---|
protected Collection
| |
| _deserializeFromString | back to summary |
|---|---|
| protected Collection Logic extracted to deal with incoming String value.
| |
| _deserializeWithObjectId | back to summary |
|---|---|
| protected Collection | |
| _tryToAddNull | back to summary |
|---|---|
| protected void _tryToAddNull(JsonParser p, DeserializationContext ctxt, Collection<?> set) throws IOException
| |
| createContextual | back to summary |
|---|---|
| public CollectionDeserializer createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException Implements com. Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.
| |
| createDefaultInstance | back to summary |
|---|---|
protected Collection
| |
| deserialize | back to summary |
|---|---|
| public Collection Implements abstract com. Doc from com. 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)
| |
| deserialize | back to summary |
|---|---|
| public Collection Overrides com. Doc from com. Alternate deserialization method (compared to the most commonly
used,
Default implementation just throws
| |
| deserializeWithType | back to summary |
|---|---|
| public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException Overrides com. Doc from com. 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.
| |
| getContentDeserializer | back to summary |
|---|---|
| public JsonDeserializer Implements abstract com. Doc from com. Accesor for deserializer use for deserializing content values.
| |
| getValueInstantiator | back to summary |
|---|---|
| public ValueInstantiator getValueInstantiator() Overrides com. Implements com.
| |
| handleNonArray | back to summary |
|---|---|
| protected final Collection 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.
| |
| isCachable | back to summary |
|---|---|
| public boolean isCachable() Overrides com. Doc from com. 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 Default implementation returns false, to indicate that no caching is done.
| |
| logicalType | back to summary |
|---|---|
| public LogicalType logicalType() Overrides com. Doc from com. 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.
| |
| withResolved | back to summary |
|---|---|
| protected CollectionDeserializer withResolved(JsonDeserializer<?> dd, JsonDeserializer<?> vd, TypeDeserializer vtd, NullValueProvider nuller, Boolean unwrapSingle) Fluent-factory method call to construct contextual instance.
| |
#id parameter from handleResolvedForwardReference(Object, Object)
comes before the values in next.
| Modifier and Type | Field and Description |
|---|---|
| private final CollectionDeserializer. | |
| public final List |
| Access | Constructor and Description |
|---|---|
| pack-priv | CollectionReferring(CollectionDeserializer.
|
| Modifier and Type | Method and Description |
|---|---|
| public void |
| _parent | back to summary |
|---|---|
| private final CollectionDeserializer. | |
| next | back to summary |
|---|---|
| public final List<Object> next | |
| CollectionReferring | back to summary |
|---|---|
| pack-priv CollectionReferring(CollectionDeserializer. | |
| handleResolvedForwardReference | back to summary |
|---|---|
| public void handleResolvedForwardReference(Object id, Object value) throws IOException Implements abstract com.
| |
| Modifier and Type | Field and Description |
|---|---|
| private List | _accumulator
A list of |
| private final Class | |
| private final Collection |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | |
| public ReadableObjectId. | |
| public void |
| _accumulator | back to summary |
|---|---|
| private List<CollectionDeserializer. A list of | |
| _elementType | back to summary |
|---|---|
| private final Class<?> _elementType | |
| _result | back to summary |
|---|---|
| private final Collection<Object> _result | |
| CollectionReferringAccumulator | back to summary |
|---|---|
| public CollectionReferringAccumulator(Class<?> elementType, Collection<Object> result) | |
| add | back to summary |
|---|---|
| public void add(Object value) | |
| handleUnresolvedReference | back to summary |
|---|---|
| public ReadableObjectId. | |
| resolveForwardReference | back to summary |
|---|---|
| public void resolveForwardReference(Object id, Object value) throws IOException | |