Module tools.jackson.databind

Package tools.jackson.databind.deser.std

Class StdValueInstantiator

java.lang.Object

tools.jackson.databind.deser.ValueInstantiator

tools.jackson.databind.deser.std.StdValueInstantiator

public class StdValueInstantiator
extends ValueInstantiator

Default ValueInstantiator implementation, which supports Creator methods that can be indicated by standard Jackson annotations.

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.deser.ValueInstantiator

ValueInstantiator.Base, ValueInstantiator.Delegating, ValueInstantiator.Gettable

Field Summary

Fields

Modifier and Type	Field	Description
protected SettableBeanProperty[]	_arrayDelegateArguments
protected AnnotatedWithParams	_arrayDelegateCreator
protected JavaType	_arrayDelegateType
protected SettableBeanProperty[]	_constructorArguments
protected AnnotatedWithParams	_defaultCreator	Default (no-argument) constructor to use for instantiation (with createUsingDefault(tools.jackson.databind.DeserializationContext))
protected SettableBeanProperty[]	_delegateArguments
protected AnnotatedWithParams	_delegateCreator
protected JavaType	_delegateType
protected AnnotatedWithParams	_fromBigDecimalCreator
protected AnnotatedWithParams	_fromBigIntegerCreator
protected AnnotatedWithParams	_fromBooleanCreator
protected AnnotatedWithParams	_fromDoubleCreator
protected AnnotatedWithParams	_fromIntCreator
protected AnnotatedWithParams	_fromLongCreator
protected AnnotatedWithParams	_fromStringCreator
protected final Class<?>	_valueClass
protected final String	_valueTypeDesc	Type of values that are instantiated; used for error reporting purposes.
protected AnnotatedWithParams	_withArgsCreator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StdValueInstantiator(StdValueInstantiator src)	Copy-constructor that sub-classes can use when creating new instances by fluent-style construction
	StdValueInstantiator(DeserializationConfig config, JavaType valueType)

Method Summary

Modifier and Type	Method	Description
boolean	canCreateFromBigDecimal()	Method that can be called to check whether a BigDecimal based creator is available to use (to call ValueInstantiator.createFromBigDecimal(tools.jackson.databind.DeserializationContext, java.math.BigDecimal)).
boolean	canCreateFromBigInteger()	Method that can be called to check whether a BigInteger based creator is available to use (to call ValueInstantiator.createFromBigInteger(tools.jackson.databind.DeserializationContext, java.math.BigInteger))
boolean	canCreateFromBoolean()	Method that can be called to check whether a double (boolean / Boolean) based creator is available to use (to call ValueInstantiator.createFromDouble(tools.jackson.databind.DeserializationContext, double)).
boolean	canCreateFromDouble()	Method that can be called to check whether a double (double / Double) based creator is available to use (to call ValueInstantiator.createFromDouble(tools.jackson.databind.DeserializationContext, double)).
boolean	canCreateFromInt()	Method that can be called to check whether an integer (int, Integer) based creator is available to use (to call ValueInstantiator.createFromInt(tools.jackson.databind.DeserializationContext, int)).
boolean	canCreateFromLong()	Method that can be called to check whether a long (long, Long) based creator is available to use (to call ValueInstantiator.createFromLong(tools.jackson.databind.DeserializationContext, long)).
boolean	canCreateFromObjectWith()	Method that can be called to check whether a property-based creator (argument-taking constructor or factory method) is available to instantiate values from JSON Object
boolean	canCreateFromString()	Method that can be called to check whether a String-based creator is available for this instantiator.
boolean	canCreateUsingArrayDelegate()	Method that can be called to check whether a array-delegate-based creator (single-arg constructor or factory method) is available for this instantiator
boolean	canCreateUsingDefault()	Method that can be called to check whether a default creator (constructor, or no-arg static factory method) is available for this instantiator
boolean	canCreateUsingDelegate()	Method that can be called to check whether a delegate-based creator (single-arg constructor or factory method) is available for this instantiator
boolean	canInstantiate()	Method that will return true if any of canCreateXxx method returns true: that is, if there is any way that an instance could be created.
void	configureFromArraySettings(AnnotatedWithParams arrayDelegateCreator, JavaType arrayDelegateType, SettableBeanProperty[] arrayDelegateArgs)
void	configureFromBigDecimalCreator(AnnotatedWithParams creator)
void	configureFromBigIntegerCreator(AnnotatedWithParams creator)
void	configureFromBooleanCreator(AnnotatedWithParams creator)
void	configureFromDoubleCreator(AnnotatedWithParams creator)
void	configureFromIntCreator(AnnotatedWithParams creator)
void	configureFromLongCreator(AnnotatedWithParams creator)
void	configureFromObjectSettings(AnnotatedWithParams defaultCreator, AnnotatedWithParams delegateCreator, JavaType delegateType, SettableBeanProperty[] delegateArgs, AnnotatedWithParams withArgsCreator, SettableBeanProperty[] constructorArgs)	Method for setting properties related to instantiating values from JSON Object.
void	configureFromStringCreator(AnnotatedWithParams creator)
ValueInstantiator	createContextual(DeserializationContext ctxt, BeanDescription.Supplier beanDescRef)	"Contextualization" method that is called after construction but before first use, to allow instantiator access to context needed to possible resolve its dependencies.
Object	createFromBigDecimal(DeserializationContext ctxt, BigDecimal value)
Object	createFromBigInteger(DeserializationContext ctxt, BigInteger value)
Object	createFromBoolean(DeserializationContext ctxt, boolean value)
Object	createFromDouble(DeserializationContext ctxt, double value)
Object	createFromInt(DeserializationContext ctxt, int value)
Object	createFromLong(DeserializationContext ctxt, long value)
Object	createFromObjectWith(DeserializationContext ctxt, Object[] args)	Method called to create value instance from JSON Object when instantiation arguments are passed; this is done, for example when passing information specified with "Creator" annotations.
Object	createFromString(DeserializationContext ctxt, String value)
Object	createUsingArrayDelegate(DeserializationContext ctxt, Object delegate)	Method to called to create value instance from JSON Array using an intermediate "delegate" value to pass to createor method
Object	createUsingDefault(DeserializationContext ctxt)	Method called to create value instance from a JSON value when no data needs to passed to creator (constructor, factory method); typically this will call the default constructor of the value object.
Object	createUsingDefaultOrWithoutArguments(DeserializationContext ctxt)	Combination of ValueInstantiator.createUsingDefault(tools.jackson.databind.DeserializationContext) and ValueInstantiator.createFromObjectWith(DeserializationContext, Object[]) which will call former first, if possible; or latter if possible (with null arguments); and if neither works throw an exception.
Object	createUsingDelegate(DeserializationContext ctxt, Object delegate)	Method to called to create value instance from JSON Object using an intermediate "delegate" value to pass to createor method
AnnotatedWithParams	getArrayDelegateCreator()	Method that can be called to try to access member (constructor, static factory method) that is used as the "array delegate creator".
JavaType	getArrayDelegateType(DeserializationConfig config)	Method that can be used to determine what is the type of array delegate type to use, if any; if no delegates are used, will return null.
AnnotatedWithParams	getDefaultCreator()	Method that can be called to try to access member (constructor, static factory method) that is used as the "default creator" (creator that is called without arguments; typically default [zero-argument] constructor of the type).
AnnotatedWithParams	getDelegateCreator()	Method that can be called to try to access member (constructor, static factory method) that is used as the "delegate creator".
JavaType	getDelegateType(DeserializationConfig config)	Method that can be used to determine what is the type of delegate type to use, if any; if no delegates are used, will return null.
SettableBeanProperty[]	getFromObjectArguments(DeserializationConfig config)	Method called to determine types of instantiation arguments to use when creating instances with creator arguments (when ValueInstantiator.canCreateFromObjectWith() returns true).
Class<?>	getValueClass()	Accessor for raw (type-erased) type of instances to create.
String	getValueTypeDesc()	Method that returns description of the value type this instantiator handles.
AnnotatedWithParams	getWithArgsCreator()	Method that can be called to try to access member (constructor, static factory method) that is used as the "non-default creator" (constructor or factory method that takes one or more arguments).
protected DatabindException	rewrapCtorProblem(DeserializationContext ctxt, Throwable t)	Method that subclasses may call for standard handling of an exception thrown when calling constructor or factory method.
protected DatabindException	wrapAsDatabindException(DeserializationContext ctxt, Throwable t)	Helper method that will return given Throwable case as a DatabindException (if it is of that type), or call DeserializationContext.instantiationException(Class, Throwable) to produce and return suitable DatabindException.

Methods inherited from class tools.jackson.databind.deser.ValueInstantiator

createFromObjectWith

Methods inherited from class java.lang.Object

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

Field Details

_valueTypeDesc

protected final String _valueTypeDesc

Type of values that are instantiated; used for error reporting purposes.

_valueClass

protected final Class<?> _valueClass

_defaultCreator

protected AnnotatedWithParams _defaultCreator

Default (no-argument) constructor to use for instantiation (with createUsingDefault(tools.jackson.databind.DeserializationContext))

_withArgsCreator

protected AnnotatedWithParams _withArgsCreator

_constructorArguments

protected SettableBeanProperty[] _constructorArguments

_delegateType

protected JavaType _delegateType

_delegateCreator

protected AnnotatedWithParams _delegateCreator

_delegateArguments

protected SettableBeanProperty[] _delegateArguments

_arrayDelegateType

protected JavaType _arrayDelegateType

_arrayDelegateCreator

protected AnnotatedWithParams _arrayDelegateCreator

_arrayDelegateArguments

protected SettableBeanProperty[] _arrayDelegateArguments

_fromStringCreator

protected AnnotatedWithParams _fromStringCreator

_fromIntCreator

protected AnnotatedWithParams _fromIntCreator

_fromLongCreator

protected AnnotatedWithParams _fromLongCreator

_fromBigIntegerCreator

protected AnnotatedWithParams _fromBigIntegerCreator

_fromDoubleCreator

protected AnnotatedWithParams _fromDoubleCreator

_fromBigDecimalCreator

protected AnnotatedWithParams _fromBigDecimalCreator

_fromBooleanCreator

protected AnnotatedWithParams _fromBooleanCreator

Constructor Details

StdValueInstantiator

public StdValueInstantiator(DeserializationConfig config,
 JavaType valueType)

StdValueInstantiator

protected StdValueInstantiator(StdValueInstantiator src)

Copy-constructor that sub-classes can use when creating new instances by fluent-style construction

Method Details

createContextual

public ValueInstantiator createContextual(DeserializationContext ctxt,
 BeanDescription.Supplier beanDescRef)

Description copied from class: ValueInstantiator

"Contextualization" method that is called after construction but before first use, to allow instantiator access to context needed to possible resolve its dependencies.

Specified by:

createContextual in class ValueInstantiator

Parameters:

ctxt - Currently active deserialization context: needed to (for example) resolving TypeDeserializers.

Returns:

This instance, if no change, or newly constructed instance

configureFromObjectSettings

public void configureFromObjectSettings(AnnotatedWithParams defaultCreator,
 AnnotatedWithParams delegateCreator,
 JavaType delegateType,
 SettableBeanProperty[] delegateArgs,
 AnnotatedWithParams withArgsCreator,
 SettableBeanProperty[] constructorArgs)

Method for setting properties related to instantiating values from JSON Object. We will choose basically only one approach (out of possible three), and clear other properties

configureFromArraySettings

public void configureFromArraySettings(AnnotatedWithParams arrayDelegateCreator,
 JavaType arrayDelegateType,
 SettableBeanProperty[] arrayDelegateArgs)

configureFromStringCreator

public void configureFromStringCreator(AnnotatedWithParams creator)

configureFromIntCreator

public void configureFromIntCreator(AnnotatedWithParams creator)

configureFromLongCreator

public void configureFromLongCreator(AnnotatedWithParams creator)

configureFromBigIntegerCreator

public void configureFromBigIntegerCreator(AnnotatedWithParams creator)

configureFromDoubleCreator

public void configureFromDoubleCreator(AnnotatedWithParams creator)

configureFromBigDecimalCreator

public void configureFromBigDecimalCreator(AnnotatedWithParams creator)

configureFromBooleanCreator

public void configureFromBooleanCreator(AnnotatedWithParams creator)

getValueTypeDesc

public String getValueTypeDesc()

Description copied from class: ValueInstantiator

Method that returns description of the value type this instantiator handles. Used for error messages, diagnostics.

Specified by:

getValueTypeDesc in class ValueInstantiator

getValueClass

public Class<?> getValueClass()

Description copied from class: ValueInstantiator

Accessor for raw (type-erased) type of instances to create.

Specified by:

getValueClass in class ValueInstantiator

canCreateFromString

public boolean canCreateFromString()

Description copied from class: ValueInstantiator

Method that can be called to check whether a String-based creator is available for this instantiator.

NOTE: does NOT include possible case of fallbacks, or coercion; only considers explicit creator.

Overrides:

canCreateFromString in class ValueInstantiator

canCreateFromInt

public boolean canCreateFromInt()

Description copied from class: ValueInstantiator

Method that can be called to check whether an integer (int, Integer) based creator is available to use (to call ValueInstantiator.createFromInt(tools.jackson.databind.DeserializationContext, int)).

Overrides:

canCreateFromInt in class ValueInstantiator

canCreateFromLong

public boolean canCreateFromLong()

Description copied from class: ValueInstantiator

Method that can be called to check whether a long (long, Long) based creator is available to use (to call ValueInstantiator.createFromLong(tools.jackson.databind.DeserializationContext, long)).

Overrides:

canCreateFromLong in class ValueInstantiator

canCreateFromBigInteger

public boolean canCreateFromBigInteger()

Description copied from class: ValueInstantiator

Method that can be called to check whether a BigInteger based creator is available to use (to call ValueInstantiator.createFromBigInteger(tools.jackson.databind.DeserializationContext, java.math.BigInteger)). +

Overrides:

canCreateFromBigInteger in class ValueInstantiator

canCreateFromDouble

public boolean canCreateFromDouble()

Description copied from class: ValueInstantiator

Method that can be called to check whether a double (double / Double) based creator is available to use (to call ValueInstantiator.createFromDouble(tools.jackson.databind.DeserializationContext, double)).

Overrides:

canCreateFromDouble in class ValueInstantiator

canCreateFromBigDecimal

public boolean canCreateFromBigDecimal()

Description copied from class: ValueInstantiator

Method that can be called to check whether a BigDecimal based creator is available to use (to call ValueInstantiator.createFromBigDecimal(tools.jackson.databind.DeserializationContext, java.math.BigDecimal)).

Overrides:

canCreateFromBigDecimal in class ValueInstantiator

canCreateFromBoolean

public boolean canCreateFromBoolean()

Description copied from class: ValueInstantiator

Method that can be called to check whether a double (boolean / Boolean) based creator is available to use (to call ValueInstantiator.createFromDouble(tools.jackson.databind.DeserializationContext, double)).

Overrides:

canCreateFromBoolean in class ValueInstantiator

canCreateUsingDefault

public boolean canCreateUsingDefault()

Description copied from class: ValueInstantiator

Method that can be called to check whether a default creator (constructor, or no-arg static factory method) is available for this instantiator

Overrides:

canCreateUsingDefault in class ValueInstantiator

canCreateUsingDelegate

public boolean canCreateUsingDelegate()

Description copied from class: ValueInstantiator

Method that can be called to check whether a delegate-based creator (single-arg constructor or factory method) is available for this instantiator

Overrides:

canCreateUsingDelegate in class ValueInstantiator

canCreateUsingArrayDelegate

public boolean canCreateUsingArrayDelegate()

Description copied from class: ValueInstantiator

Method that can be called to check whether a array-delegate-based creator (single-arg constructor or factory method) is available for this instantiator

Overrides:

canCreateUsingArrayDelegate in class ValueInstantiator

canCreateFromObjectWith

public boolean canCreateFromObjectWith()

Description copied from class: ValueInstantiator

Method that can be called to check whether a property-based creator (argument-taking constructor or factory method) is available to instantiate values from JSON Object

Overrides:

canCreateFromObjectWith in class ValueInstantiator

canInstantiate

public boolean canInstantiate()

Description copied from class: ValueInstantiator

Method that will return true if any of canCreateXxx method returns true: that is, if there is any way that an instance could be created.

Overrides:

canInstantiate in class ValueInstantiator

getDelegateType

public JavaType getDelegateType(DeserializationConfig config)

Description copied from class: ValueInstantiator

Method that can be used to determine what is the type of delegate type to use, if any; if no delegates are used, will return null. If non-null type is returned, deserializer will bind JSON into specified type (using standard deserializer for that type), and pass that to instantiator.

Overrides:

getDelegateType in class ValueInstantiator

getArrayDelegateType

public JavaType getArrayDelegateType(DeserializationConfig config)

Description copied from class: ValueInstantiator

Method that can be used to determine what is the type of array delegate type to use, if any; if no delegates are used, will return null. If non-null type is returned, deserializer will bind JSON into specified type (using standard deserializer for that type), and pass that to instantiator.

Overrides:

getArrayDelegateType in class ValueInstantiator

getFromObjectArguments

public SettableBeanProperty[] getFromObjectArguments(DeserializationConfig config)

Description copied from class: ValueInstantiator

Method called to determine types of instantiation arguments to use when creating instances with creator arguments (when ValueInstantiator.canCreateFromObjectWith() returns true). These arguments are bound from JSON, using specified property types to locate deserializers.

NOTE: all properties will be of type CreatorProperty.

Overrides:

getFromObjectArguments in class ValueInstantiator

createUsingDefault

public Object createUsingDefault(DeserializationContext ctxt)
                          throws JacksonException

Description copied from class: ValueInstantiator

Method called to create value instance from a JSON value when no data needs to passed to creator (constructor, factory method); typically this will call the default constructor of the value object. It will only be used if more specific creator methods are not applicable; hence "default".

This method is called if ValueInstantiator.getFromObjectArguments(tools.jackson.databind.DeserializationConfig) returns null or empty List.

Overrides:

createUsingDefault in class ValueInstantiator

Throws:

JacksonException

createFromObjectWith

public Object createFromObjectWith(DeserializationContext ctxt,
 Object[] args)
                            throws JacksonException

Description copied from class: ValueInstantiator

Method called to create value instance from JSON Object when instantiation arguments are passed; this is done, for example when passing information specified with "Creator" annotations.

This method is called if ValueInstantiator.getFromObjectArguments(tools.jackson.databind.DeserializationConfig) returns a non-empty List of arguments.

Overrides:

createFromObjectWith in class ValueInstantiator

Throws:

JacksonException

createUsingDefaultOrWithoutArguments

public Object createUsingDefaultOrWithoutArguments(DeserializationContext ctxt)
                                            throws JacksonException

Description copied from class: ValueInstantiator

Combination of ValueInstantiator.createUsingDefault(tools.jackson.databind.DeserializationContext) and ValueInstantiator.createFromObjectWith(DeserializationContext, Object[]) which will call former first, if possible; or latter if possible (with null arguments); and if neither works throw an exception.

Overrides:

createUsingDefaultOrWithoutArguments in class ValueInstantiator

Throws:

JacksonException

createUsingDelegate

public Object createUsingDelegate(DeserializationContext ctxt,
 Object delegate)
                           throws JacksonException

Description copied from class: ValueInstantiator

Method to called to create value instance from JSON Object using an intermediate "delegate" value to pass to createor method

Overrides:

createUsingDelegate in class ValueInstantiator

Throws:

JacksonException

createUsingArrayDelegate

public Object createUsingArrayDelegate(DeserializationContext ctxt,
 Object delegate)
                                throws JacksonException

Description copied from class: ValueInstantiator

Method to called to create value instance from JSON Array using an intermediate "delegate" value to pass to createor method

Overrides:

createUsingArrayDelegate in class ValueInstantiator

Throws:

JacksonException

createFromString

public Object createFromString(DeserializationContext ctxt,
 String value)
                        throws JacksonException

Overrides:

createFromString in class ValueInstantiator

Throws:

JacksonException

createFromInt

public Object createFromInt(DeserializationContext ctxt,
 int value)
                     throws JacksonException

Overrides:

createFromInt in class ValueInstantiator

Throws:

JacksonException

createFromLong

public Object createFromLong(DeserializationContext ctxt,
 long value)
                      throws JacksonException

Overrides:

createFromLong in class ValueInstantiator

Throws:

JacksonException

createFromBigInteger

public Object createFromBigInteger(DeserializationContext ctxt,
 BigInteger value)
                            throws JacksonException

Overrides:

createFromBigInteger in class ValueInstantiator

Throws:

JacksonException

createFromDouble

public Object createFromDouble(DeserializationContext ctxt,
 double value)
                        throws JacksonException

Overrides:

createFromDouble in class ValueInstantiator

Throws:

JacksonException

createFromBigDecimal

public Object createFromBigDecimal(DeserializationContext ctxt,
 BigDecimal value)
                            throws JacksonException

Overrides:

createFromBigDecimal in class ValueInstantiator

Throws:

JacksonException

createFromBoolean

public Object createFromBoolean(DeserializationContext ctxt,
 boolean value)
                         throws JacksonException

Overrides:

createFromBoolean in class ValueInstantiator

Throws:

JacksonException

getDelegateCreator

public AnnotatedWithParams getDelegateCreator()

Description copied from class: ValueInstantiator

Method that can be called to try to access member (constructor, static factory method) that is used as the "delegate creator". Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even if ValueInstantiator.canCreateUsingDelegate() returns true, this method may return null .

Overrides:

getDelegateCreator in class ValueInstantiator

getArrayDelegateCreator

public AnnotatedWithParams getArrayDelegateCreator()

Description copied from class: ValueInstantiator

Method that can be called to try to access member (constructor, static factory method) that is used as the "array delegate creator". Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even if ValueInstantiator.canCreateUsingArrayDelegate() returns true, this method may return null .

Overrides:

getArrayDelegateCreator in class ValueInstantiator

getDefaultCreator

public AnnotatedWithParams getDefaultCreator()

Description copied from class: ValueInstantiator

Method that can be called to try to access member (constructor, static factory method) that is used as the "default creator" (creator that is called without arguments; typically default [zero-argument] constructor of the type). Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even if ValueInstantiator.canCreateUsingDefault() returns true, this method may return null .

Overrides:

getDefaultCreator in class ValueInstantiator

getWithArgsCreator

public AnnotatedWithParams getWithArgsCreator()

Description copied from class: ValueInstantiator

Method that can be called to try to access member (constructor, static factory method) that is used as the "non-default creator" (constructor or factory method that takes one or more arguments). Note that implementations not required to return actual object they use (or, they may use some other instantiation) method. That is, even if ValueInstantiator.canCreateFromObjectWith() returns true, this method may return null .

Overrides:

getWithArgsCreator in class ValueInstantiator

wrapAsDatabindException

protected DatabindException wrapAsDatabindException(DeserializationContext ctxt,
 Throwable t)

Helper method that will return given Throwable case as a DatabindException (if it is of that type), or call DeserializationContext.instantiationException(Class, Throwable) to produce and return suitable DatabindException.

rewrapCtorProblem

protected DatabindException rewrapCtorProblem(DeserializationContext ctxt,
 Throwable t)

Method that subclasses may call for standard handling of an exception thrown when calling constructor or factory method. Will unwrap ExceptionInInitializerError and InvocationTargetExceptions, then call wrapAsDatabindException(tools.jackson.databind.DeserializationContext, java.lang.Throwable).