Module tools.jackson.databind

Package tools.jackson.databind.deser.bean

Class PropertyBasedCreator

java.lang.Object

tools.jackson.databind.deser.bean.PropertyBasedCreator

public final class PropertyBasedCreator
extends Object

Object that is used to collect arguments for non-default creator (non-default-constructor, or argument-taking factory method) before creator can be called. Since ordering of JSON properties is not guaranteed, this may require buffering of values other than ones being passed to creator.

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	_hasManagedReferenceProperties	Flag indicating whether any creator properties are ManagedReferenceProperty instances, used to optimize deserialization by skipping back-reference injection when not needed.
protected final BitSet	_injectablePropIndexes	Indexes of properties with associated Injectable values, if any: null if none.
protected final SettableBeanProperty[]	_propertiesInOrder	Array that contains properties that match creator properties
protected final int	_propertyCount	Number of properties: usually same as size of _propertyLookup, but not necessarily, when we have unnamed injectable properties.
protected final HashMap<String,SettableBeanProperty>	_propertyLookup	Map that contains property objects for either constructor or factory method (whichever one is null: one property for each parameter for that one), keyed by logical property name
protected final ValueInstantiator	_valueInstantiator	Helper object that knows how to actually construct the instance by invoking creator method with buffered arguments.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PropertyBasedCreator(PropertyBasedCreator base, HashMap<String,SettableBeanProperty> propertyLookup, SettableBeanProperty[] allProperties)
protected	PropertyBasedCreator(DeserializationContext ctxt, ValueInstantiator valueInstantiator, SettableBeanProperty[] creatorProps, boolean caseInsensitive, boolean addAliases)

Method Summary

Modifier and Type	Method	Description
SettableBeanProperty[]	allPropertiesInOrder()	Returns all creator properties in creator-index order, including ones marked ignorable (which properties() excludes).
Object	build(DeserializationContext ctxt, PropertyValueBuffer buffer)
static PropertyBasedCreator	construct(DeserializationContext ctxt, ValueInstantiator valueInstantiator, SettableBeanProperty[] srcCreatorProps, boolean caseInsensitive)	Factory method used for building actual instances to be used with types OTHER than POJOs.
static PropertyBasedCreator	construct(DeserializationContext ctxt, ValueInstantiator valueInstantiator, SettableBeanProperty[] srcCreatorProps, BeanPropertyMap allProperties)	Factory method used for building actual instances to be used with POJOs: resolves deserializers, checks for "null values".
SettableBeanProperty	findCreatorProperty(int propertyIndex)
SettableBeanProperty	findCreatorProperty(String name)
boolean	hasManagedReferenceProperties()
Collection<SettableBeanProperty>	properties()
PropertyBasedCreator	renameAll(DeserializationContext ctxt, NameTransformer transformer)	Mutant factory method for constructing a creator where property names are transformed using the given NameTransformer.
PropertyValueBuffer	startBuilding(JsonParser p, DeserializationContext ctxt, ObjectIdReader oir)	Deprecated. Since 3.2
PropertyValueBuffer	startBuilding(JsonParser p, DeserializationContext ctxt, ObjectIdReader oir, boolean mayRebind)	Method called when starting to build a bean instance.
PropertyValueBuffer	startBuildingWithAnySetter(JsonParser p, DeserializationContext ctxt, ObjectIdReader oir, SettableAnyProperty anySetter)	Deprecated. Since 3.2
PropertyValueBuffer	startBuildingWithAnySetter(JsonParser p, DeserializationContext ctxt, ObjectIdReader oir, SettableAnyProperty anySetter, boolean mayRebind)	Method called when starting to build a bean instance.

Methods inherited from class java.lang.Object

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

Field Details

_propertyCount

protected final int _propertyCount

Number of properties: usually same as size of _propertyLookup, but not necessarily, when we have unnamed injectable properties.

_valueInstantiator

protected final ValueInstantiator _valueInstantiator

Helper object that knows how to actually construct the instance by invoking creator method with buffered arguments.

_propertyLookup

protected final HashMap<String,SettableBeanProperty> _propertyLookup

Map that contains property objects for either constructor or factory method (whichever one is null: one property for each parameter for that one), keyed by logical property name

_propertiesInOrder

protected final SettableBeanProperty[] _propertiesInOrder

Array that contains properties that match creator properties

_injectablePropIndexes

protected final BitSet _injectablePropIndexes

Indexes of properties with associated Injectable values, if any: null if none.

_hasManagedReferenceProperties

protected final boolean _hasManagedReferenceProperties

Flag indicating whether any creator properties are ManagedReferenceProperty instances, used to optimize deserialization by skipping back-reference injection when not needed.

Since:

3.1

Constructor Details

PropertyBasedCreator

protected PropertyBasedCreator(DeserializationContext ctxt,
 ValueInstantiator valueInstantiator,
 SettableBeanProperty[] creatorProps,
 boolean caseInsensitive,
 boolean addAliases)

PropertyBasedCreator

protected PropertyBasedCreator(PropertyBasedCreator base,
 HashMap<String,SettableBeanProperty> propertyLookup,
 SettableBeanProperty[] allProperties)

Method Details

construct

public static PropertyBasedCreator construct(DeserializationContext ctxt,
 ValueInstantiator valueInstantiator,
 SettableBeanProperty[] srcCreatorProps,
 BeanPropertyMap allProperties)

Factory method used for building actual instances to be used with POJOs: resolves deserializers, checks for "null values".

construct

public static PropertyBasedCreator construct(DeserializationContext ctxt,
 ValueInstantiator valueInstantiator,
 SettableBeanProperty[] srcCreatorProps,
 boolean caseInsensitive)

Factory method used for building actual instances to be used with types OTHER than POJOs. resolves deserializers and checks for "null values".

renameAll

public PropertyBasedCreator renameAll(DeserializationContext ctxt,
 NameTransformer transformer)

Mutant factory method for constructing a creator where property names are transformed using the given NameTransformer.

NOTE: transformer is applied to property names only; value deserializers are left untouched. See BeanPropertyMap.renameAll(tools.jackson.databind.DeserializationContext, tools.jackson.databind.util.NameTransformer) for rationale (see [databind#3178]).

Since:

2.19

properties

public Collection<SettableBeanProperty> properties()

allPropertiesInOrder

public SettableBeanProperty[] allPropertiesInOrder()

Returns all creator properties in creator-index order, including ones marked ignorable (which properties() excludes).

Returned array is shared internal state; callers must not mutate it.

Since:

3.2

findCreatorProperty

public SettableBeanProperty findCreatorProperty(String name)

findCreatorProperty

public SettableBeanProperty findCreatorProperty(int propertyIndex)

hasManagedReferenceProperties

public boolean hasManagedReferenceProperties()

Since:

3.1

startBuilding

@Deprecated
public PropertyValueBuffer startBuilding(JsonParser p,
 DeserializationContext ctxt,
 ObjectIdReader oir)

Deprecated.

Since 3.2

Method called when starting to build a bean instance.

startBuilding

public PropertyValueBuffer startBuilding(JsonParser p,
 DeserializationContext ctxt,
 ObjectIdReader oir,
 boolean mayRebind)

Method called when starting to build a bean instance.

The mayRebind flag (added with [databind#5909]) signals that the constructed instance is a Builder that will be rebuilt via finishBuild, so resolved Object Id Referrings need to be retained for later replay.

Since:

3.2

startBuildingWithAnySetter

@Deprecated
public PropertyValueBuffer startBuildingWithAnySetter(JsonParser p,
 DeserializationContext ctxt,
 ObjectIdReader oir,
 SettableAnyProperty anySetter)

Deprecated.

Since 3.2

startBuildingWithAnySetter

public PropertyValueBuffer startBuildingWithAnySetter(JsonParser p,
 DeserializationContext ctxt,
 ObjectIdReader oir,
 SettableAnyProperty anySetter,
 boolean mayRebind)

Method called when starting to build a bean instance.

See startBuilding(JsonParser, DeserializationContext, ObjectIdReader, boolean) for the meaning of mayRebind ([databind#5909]).

Since:

3.2

build

public Object build(DeserializationContext ctxt,
 PropertyValueBuffer buffer)
             throws JacksonException

Throws:

JacksonException