Class JsonNodeDeserializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonDeserializer<T>
-
- com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>
-
- com.fasterxml.jackson.databind.deser.std.JsonNodeDeserializer
-
- All Implemented Interfaces:
ContextualDeserializer
,NullValueProvider
,ValueInstantiator.Gettable
,java.io.Serializable
public class JsonNodeDeserializer extends StdDeserializer<T>
Deserializer that can build instances ofJsonNode
from any JSON content, using appropriateJsonNode
type.Rewritten in Jackson 2.13 to avoid recursion and allow handling of very deeply nested structures.
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.JsonNode
deserialize(JsonParser p, DeserializationContext ctxt)
Implementation that will produce types of any JSON nodes; not just one deserializer is registered to handle (in case of more specialized handler).java.lang.Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)
Base implementation that does not assume specific type inclusion mechanism.java.lang.Object
getAbsentValue(DeserializationContext ctxt)
Overridden variant to ensure that absent values are NOT coerced intoNullNode
s, unlike incomingnull
values.static JsonDeserializer<? extends JsonNode>
getDeserializer(java.lang.Class<?> nodeClass)
Factory method for accessing deserializer for specific node typeJsonNode
getNullValue(DeserializationContext ctxt)
Method that can be called to determine value to be used for representing null values (values deserialized when JSON token isJsonToken.VALUE_NULL
).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).LogicalType
logicalType()
Method for accessing logical type of values this deserializer produces.java.lang.Boolean
supportsUpdate(DeserializationConfig config)
Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.-
Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
getValueClass, getValueInstantiator, getValueType, getValueType, handledType
-
Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
deserialize, deserializeWithType, findBackReference, getDelegatee, getEmptyAccessPattern, getEmptyValue, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getNullValue, getObjectIdReader, replaceDelegatee, unwrappingDeserializer
-
-
-
-
Method Detail
-
getDeserializer
public static JsonDeserializer<? extends JsonNode> getDeserializer(java.lang.Class<?> nodeClass)
Factory method for accessing deserializer for specific node type
-
getNullValue
public JsonNode getNullValue(DeserializationContext ctxt)
Description copied from class:JsonDeserializer
Method that can be called to determine value to be used for representing null values (values deserialized when JSON token isJsonToken.VALUE_NULL
). Usually this is simply Java null, but for some types (especially primitives) it may be necessary to use non-null values.This method may be called once, or multiple times, depending on what
JsonDeserializer.getNullAccessPattern()
returns.Default implementation simply returns null.
- Specified by:
getNullValue
in interfaceNullValueProvider
- Overrides:
getNullValue
in classJsonDeserializer<JsonNode>
-
getAbsentValue
public java.lang.Object getAbsentValue(DeserializationContext ctxt)
Overridden variant to ensure that absent values are NOT coerced intoNullNode
s, unlike incomingnull
values.- Specified by:
getAbsentValue
in interfaceNullValueProvider
- Overrides:
getAbsentValue
in classJsonDeserializer<JsonNode>
-
deserialize
public JsonNode deserialize(JsonParser p, DeserializationContext ctxt) throws java.io.IOException
Implementation that will produce types of any JSON nodes; not just one deserializer is registered to handle (in case of more specialized handler). Overridden by typed sub-classes for more thorough checking- Specified by:
deserialize
in classJsonDeserializer<JsonNode>
- Parameters:
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about this deserialization activity.- Returns:
- Deserialized value
- Throws:
java.io.IOException
-
supportsUpdate
public java.lang.Boolean supportsUpdate(DeserializationConfig config)
Description copied from class:JsonDeserializer
Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not. Return value should either beBoolean.FALSE
if update is not supported at all (immutable values);Boolean.TRUE
if update should usually work (regular POJOs, for example), ornull
if this is either not known, or may sometimes work.Information gathered is typically used to either prevent merging update for property (either by skipping, if based on global defaults; or by exception during deserializer construction if explicit attempt made) if
Boolean.FALSE
returned, or inclusion ifBoolean.TRUE
is specified. If "unknown" case (null
returned) behavior is to exclude property if global defaults used; or to allow if explicit per-type or property merging is defined.Default implementation returns
null
to allow explicit per-type or per-property attempts.
-
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 classStdDeserializer<T extends JsonNode>
typeDeserializer
- Deserializer to use for handling type information- Throws:
java.io.IOException
-
logicalType
public LogicalType logicalType()
Description copied from class:JsonDeserializer
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.- Overrides:
logicalType
in classJsonDeserializer<T extends JsonNode>
- Returns:
- Logical type of values this deserializer produces, if known;
null
if not
-
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 classJsonDeserializer<T extends JsonNode>
-
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 interfaceContextualDeserializer
- Parameters:
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)- Returns:
- Deserializer to use for deserializing values of specified property; may be this instance or a new instance.
- Throws:
JsonMappingException
-
-