Top Description Inners Constructors Methods
com.fasterxml.jackson.databind.deser

public abstract Class ValueInstantiator

extends Object
Class Inheritance
Known Direct Subclasses
com.fasterxml.jackson.databind.deser.ValueInstantiator.Base, com.fasterxml.jackson.databind.deser.ValueInstantiator.Delegating, com.fasterxml.jackson.databind.deser.std.StdValueInstantiator
Imports
java.io.IOException, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.cfg.CoercionAction, .CoercionInputShape, com.fasterxml.jackson.databind.deser.impl.PropertyValueBuffer, com.fasterxml.jackson.databind.introspect.AnnotatedWithParams, com.fasterxml.jackson.databind.type.LogicalType, java.math.BigDecimal, .BigInteger
Class that defines simple API implemented by objects that create value instances. Some or all of properties of value instances may be initialized by instantiator, rest being populated by deserializer, to which value instance is passed. Since different kinds of JSON values (structured and scalar) may be bound to Java values, in some cases instantiator fully defines resulting value; this is the case when JSON value is a scalar value (String, number, boolean).

Note that this type is not parameterized (even though it would seemingly make sense), because such type information cannot be use effectively during runtime: access is always using either wildcard type, or just basic java.lang.Object; and so adding type parameter seems like unnecessary extra work.

Actual implementations are strongly recommended to be based on com.fasterxml.jackson.databind.deser.std.StdValueInstantiator which implements all methods, and as such will be compatible across versions even if new methods were added to this interface.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ValueInstantiator.Base

Partial ValueInstantiator implementation that is strongly recommended to be used instead of directly extending ValueInstantiator itself.

public static class
ValueInstantiator.Delegating

Delegating ValueInstantiator implementation meant as a base type that by default delegates methods to specified fallback instantiator.

public static interface
ValueInstantiator.Gettable

Constructor Summary

AccessConstructor and Description
public
ValueInstantiator()

Method Summary

Modifier and TypeMethod and Description
protected Object
_createFromStringFallbacks(DeserializationContext ctxt, String value)

Deprecated Since 2.12 should not handle coercions here
public boolean
canCreateFromBigDecimal()

Method that can be called to check whether a BigDecimal based creator is available to use (to call createFromBigDecimal).

public boolean
canCreateFromBigInteger()

Method that can be called to check whether a BigInteger based creator is available to use (to call createFromBigInteger).

public boolean
canCreateFromBoolean()

Method that can be called to check whether a double (boolean / Boolean) based creator is available to use (to call createFromDouble).

public boolean
canCreateFromDouble()

Method that can be called to check whether a double (double / Double) based creator is available to use (to call createFromDouble).

public boolean
canCreateFromInt()

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

public boolean
canCreateFromLong()

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

public 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

public boolean
canCreateFromString()

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

public 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

public 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

public 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

public 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.

public ValueInstantiator

Returns:

This instance, if no change, or newly constructed instance
createContextual(DeserializationContext
Currently active deserialization context: needed to (for example) resolving com.fasterxml.jackson.databind.jsontype.TypeDeserializers.
ctxt, BeanDescription beanDesc)

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

public Object
createFromBigDecimal(DeserializationContext ctxt, BigDecimal value)

public Object
createFromBigInteger(DeserializationContext ctxt, BigInteger value)

public Object
createFromBoolean(DeserializationContext ctxt, boolean value)

public Object
createFromDouble(DeserializationContext ctxt, double value)

public Object
createFromInt(DeserializationContext ctxt, int value)

public Object
createFromLong(DeserializationContext ctxt, long value)

public 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.

public Object
createFromObjectWith(DeserializationContext ctxt, SettableBeanProperty[] props, PropertyValueBuffer buffer)

Method that delegates to createFromObjectWith(DeserializationContext, Object[]) by default, but can be overridden if the application should have customized behavior with respect to missing properties.

public Object
createFromString(DeserializationContext ctxt, String value)

public 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

public 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.

public Object
createUsingDefaultOrWithoutArguments(DeserializationContext ctxt)

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

public 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

public AnnotatedWithParams
getArrayDelegateCreator()

Method that can be called to try to access member (constructor, static factory method) that is used as the "array delegate creator".

public 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.

public 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).

public AnnotatedWithParams
getDelegateCreator()

Method that can be called to try to access member (constructor, static factory method) that is used as the "delegate creator".

public 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.

public SettableBeanProperty[]
getFromObjectArguments(DeserializationConfig config)

Method called to determine types of instantiation arguments to use when creating instances with creator arguments (when canCreateFromObjectWith() returns true).

public Class<?>
getValueClass()

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

public String
getValueTypeDesc()

Method that returns description of the value type this instantiator handles.

public 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).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait