Package com.fasterxml.jackson.databind.deser

Class BuilderBasedDeserializer

java.lang.Object

com.fasterxml.jackson.databind.JsonDeserializer<Object>

com.fasterxml.jackson.databind.deser.std.StdDeserializer<Object>

com.fasterxml.jackson.databind.deser.BeanDeserializerBase

com.fasterxml.jackson.databind.deser.BuilderBasedDeserializer

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, ResolvableDeserializer, ValueInstantiator.Gettable, Serializable

public class BuilderBasedDeserializer
extends BeanDeserializerBase

Class that handles deserialization using a separate Builder class, which is used for data binding and produces actual deserialized value at the end of data binding.

Note on implementation: much of code has been copied from BeanDeserializer; there may be opportunities to refactor this in future.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

JsonDeserializer.None

Constructor Summary

Constructors

Constructor	Description
BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)	Deprecated. Since 2.9
BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)	Constructor used by BeanDeserializerBuilder.
BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, Set<String> includableProps, boolean hasViews)
BuilderBasedDeserializer(BuilderBasedDeserializer src, BeanPropertyMap props)
BuilderBasedDeserializer(BuilderBasedDeserializer src, ObjectIdReader oir)
BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps)
BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps, Set<String> includableProps)

Method Summary

Modifier and Type	Method	Description
Object	deserialize(JsonParser p, DeserializationContext ctxt)	Main deserialization method for bean-based objects (POJOs).
Object	deserialize(JsonParser p, DeserializationContext ctxt, Object value)	Secondary deserialization method, called in cases where POJO instance is created as part of deserialization, potentially after collecting some or all of the properties to set.
Object	deserializeFromObject(JsonParser p, DeserializationContext ctxt)	General version used when handling needs more advanced features.
Boolean	supportsUpdate(DeserializationConfig config)	Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.
JsonDeserializer<Object>	unwrappingDeserializer(NameTransformer unwrapper)	Method that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.
BeanDeserializerBase	withBeanProperties(BeanPropertyMap props)	Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.
BeanDeserializerBase	withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps)
BeanDeserializerBase	withIgnoreAllUnknown(boolean ignoreUnknown)
BeanDeserializerBase	withObjectIdReader(ObjectIdReader oir)

Methods inherited from class com.fasterxml.jackson.databind.deser.BeanDeserializerBase

createContextual, creatorProperties, deserializeFromArray, deserializeFromBoolean, deserializeFromDouble, deserializeFromEmbedded, deserializeFromNumber, deserializeFromString, deserializeWithType, findBackReference, findProperty, findProperty, findProperty, getBeanClass, getEmptyAccessPattern, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getObjectIdReader, getPropertyCount, getValueInstantiator, getValueType, handledType, hasProperty, hasViews, isCachable, isCaseInsensitive, logicalType, properties, replaceProperty, resolve, withIgnorableProperties, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

getValueClass, getValueType

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

deserializeWithType, getAbsentValue, getDelegatee, getEmptyValue, getNullValue, getNullValue, replaceDelegatee

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BuilderBasedDeserializer

public BuilderBasedDeserializer(BeanDeserializerBuilder builder,
 BeanDescription beanDesc,
 JavaType targetType,
 BeanPropertyMap properties,
 Map<String,SettableBeanProperty> backRefs,
 Set<String> ignorableProps,
 boolean ignoreAllUnknown,
 boolean hasViews)

Constructor used by BeanDeserializerBuilder.

BuilderBasedDeserializer

public BuilderBasedDeserializer(BeanDeserializerBuilder builder,
 BeanDescription beanDesc,
 JavaType targetType,
 BeanPropertyMap properties,
 Map<String,SettableBeanProperty> backRefs,
 Set<String> ignorableProps,
 boolean ignoreAllUnknown,
 Set<String> includableProps,
 boolean hasViews)

Since:

2.12

BuilderBasedDeserializer

@Deprecated
public BuilderBasedDeserializer(BeanDeserializerBuilder builder,
 BeanDescription beanDesc,
 BeanPropertyMap properties,
 Map<String,SettableBeanProperty> backRefs,
 Set<String> ignorableProps,
 boolean ignoreAllUnknown,
 boolean hasViews)

Deprecated.

Since 2.9

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 ObjectIdReader oir)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 Set<String> ignorableProps)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 Set<String> ignorableProps,
 Set<String> includableProps)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 BeanPropertyMap props)

Method Details

unwrappingDeserializer

public JsonDeserializer<Object> unwrappingDeserializer(NameTransformer unwrapper)

Description copied from class: JsonDeserializer

Method that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.

Default implementation just returns 'this' indicating that no unwrapped variant exists

Specified by:

unwrappingDeserializer in class BeanDeserializerBase

withObjectIdReader

public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)

Specified by:

withObjectIdReader in class BeanDeserializerBase

withByNameInclusion

public BeanDeserializerBase withByNameInclusion(Set<String> ignorableProps,
 Set<String> includableProps)

Specified by:

withByNameInclusion in class BeanDeserializerBase

withIgnoreAllUnknown

public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown)

Specified by:

withIgnoreAllUnknown in class BeanDeserializerBase

withBeanProperties

public BeanDeserializerBase withBeanProperties(BeanPropertyMap props)

Description copied from class: BeanDeserializerBase

Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.

Overrides:

withBeanProperties in class BeanDeserializerBase

supportsUpdate

public 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 be Boolean.FALSE if update is not supported at all (immutable values); Boolean.TRUE if update should usually work (regular POJOs, for example), or null 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 if Boolean.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.

Overrides:

supportsUpdate in class BeanDeserializerBase

deserialize

public Object deserialize(JsonParser p,
 DeserializationContext ctxt)
                   throws IOException

Main deserialization method for bean-based objects (POJOs).

Specified by:

deserialize in class JsonDeserializer<Object>

Parameters:

p - Parsed used for reading JSON content

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

Returns:

Deserialized value

Throws:

IOException

deserialize

public Object deserialize(JsonParser p,
 DeserializationContext ctxt,
 Object value)
                   throws IOException

Secondary deserialization method, called in cases where POJO instance is created as part of deserialization, potentially after collecting some or all of the properties to set.

Overrides:

deserialize in class JsonDeserializer<Object>

Throws:

IOException

deserializeFromObject

public Object deserializeFromObject(JsonParser p,
 DeserializationContext ctxt)
                             throws IOException

General version used when handling needs more advanced features.

Specified by:

deserializeFromObject in class BeanDeserializerBase

Throws:

IOException