public class CollectionDeserializer extends ContainerDeserializerBase<java.util.Collection<java.lang.Object>> implements ContextualDeserializer
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 List
s, but not with specific
POJO types, only other containers and primitives/wrappers.
Modifier and Type | Class and Description |
---|---|
static class |
CollectionDeserializer.CollectionReferringAccumulator
Helper class for dealing with Object Id references for values contained in
collections being deserialized.
|
JsonDeserializer.None
Constructor and Description |
---|
CollectionDeserializer(JavaType collectionType,
JsonDeserializer<java.lang.Object> valueDeser,
TypeDeserializer valueTypeDeser,
ValueInstantiator valueInstantiator)
Constructor for context-free instances, where we do not yet know
which property is using this deserializer.
|
Modifier and Type | Method and Description |
---|---|
CollectionDeserializer |
createContextual(DeserializationContext ctxt,
BeanProperty property)
Method called to finalize setup of this deserializer,
when it is known for which property deserializer is needed
for.
|
java.util.Collection<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.util.Collection<java.lang.Object> |
deserialize(JsonParser p,
DeserializationContext ctxt,
java.util.Collection<java.lang.Object> result)
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.
|
ValueInstantiator |
getValueInstantiator() |
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).
|
findBackReference, getContentType, getEmptyAccessPattern, getEmptyValue, getValueType, supportsUpdate
getValueClass, getValueType, handledType
deserializeWithType, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getNullValue, getNullValue, getObjectIdReader, replaceDelegatee, unwrappingDeserializer
public CollectionDeserializer(JavaType collectionType, JsonDeserializer<java.lang.Object> valueDeser, TypeDeserializer valueTypeDeser, ValueInstantiator valueInstantiator)
public boolean isCachable()
JsonDeserializer
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.
isCachable
in class JsonDeserializer<java.util.Collection<java.lang.Object>>
public CollectionDeserializer createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException
createContextual
in interface ContextualDeserializer
ctxt
- Deserialization context to access configuration, additional
deserializers that may be needed by this deserializerproperty
- 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)JsonMappingException
public JsonDeserializer<java.lang.Object> getContentDeserializer()
ContainerDeserializerBase
getContentDeserializer
in class ContainerDeserializerBase<java.util.Collection<java.lang.Object>>
public ValueInstantiator getValueInstantiator()
getValueInstantiator
in interface ValueInstantiator.Gettable
getValueInstantiator
in class ContainerDeserializerBase<java.util.Collection<java.lang.Object>>
public java.util.Collection<java.lang.Object> deserialize(JsonParser p, DeserializationContext ctxt) throws java.io.IOException
JsonDeserializer
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.
deserialize
in class JsonDeserializer<java.util.Collection<java.lang.Object>>
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about
this deserialization activity.java.io.IOException
public java.util.Collection<java.lang.Object> deserialize(JsonParser p, DeserializationContext ctxt, java.util.Collection<java.lang.Object> result) throws java.io.IOException
JsonDeserializer
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)
deserialize
in class JsonDeserializer<java.util.Collection<java.lang.Object>>
java.io.IOException
public java.lang.Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws java.io.IOException
StdDeserializer
deserializeWithType
in class StdDeserializer<java.util.Collection<java.lang.Object>>
typeDeserializer
- Deserializer to use for handling type informationjava.io.IOException
Copyright © 2010 - 2020 Adobe. All Rights Reserved