Module tools.jackson.databind

Package tools.jackson.databind

Class DeserializationContext

java.lang.Object

tools.jackson.databind.DatabindContext

tools.jackson.databind.DeserializationContext

All Implemented Interfaces:

ObjectReadContext

Direct Known Subclasses:

DeserializationContextExt

public abstract class DeserializationContext
extends DatabindContext
implements ObjectReadContext

Context for the process of deserialization a single root-level value. Used to allow passing in configuration settings and reusable temporary objects (scrap arrays, containers). Constructed by ObjectMapper (and ObjectReader based on configuration, used mostly by ValueDeserializers to access contextual information.

Nested Class Summary

Nested classes/interfaces inherited from interface tools.jackson.core.ObjectReadContext

ObjectReadContext.Base

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<?>	_activeView	Currently active view, if any.
protected ArrayBuilders	_arrayBuilders
protected ContextAttributes	_attributes	Lazily-constructed holder for per-call attributes.
protected final DeserializerCache	_cache	Object that handle details of ValueDeserializer caching.
protected ClassIntrospector	_classIntrospector	Lazily constructed ClassIntrospector instance: created from "blueprint"
protected final DeserializationConfig	_config	Generic deserialization processing configuration
protected LinkedNode<JavaType>	_currentType	Type of ValueDeserializer on which ValueDeserializer.createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) is being called currently.
protected DateFormat	_dateFormat
protected final DeserializerFactory	_factory	Read-only factory instance; exposed to let owners (ObjectMapper, ObjectReader) access it.
protected final int	_featureFlags	Bitmap of DeserializationFeatures that are enabled
protected final InjectableValues	_injectableValues	Object used for resolving references to injectable values.
protected ObjectBuffer	_objectBuffer
protected JsonParser	_parser	Currently active parser used for deserialization.
protected JacksonFeatureSet<StreamReadCapability>	_readCapabilities	Capabilities of the input format.
protected final FormatSchema	_schema	Schema for underlying parser to use, if any.
protected final TokenStreamFactory	_streamFactory	Low-level TokenStreamFactory that may be used for constructing embedded parsers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DeserializationContext(TokenStreamFactory streamFactory, DeserializerFactory df, DeserializerCache cache, DeserializationConfig config, FormatSchema schema, InjectableValues injectableValues)

Method Summary

Modifier and Type	Method	Description
protected DateFormat	_getDateFormat()	Helper method to get a non-shared instance of DateFormat with default configuration; instance is lazily constructed, reused within same instance of context (that is, within same life-cycle of readValue() from mapper or reader).
protected boolean	_isCompatible(Class<?> target, Object value)
protected String	_shapeForToken(JsonToken t)	Helper method for constructing description like "Object value" given JsonToken encountered.
TokenBuffer	bufferAsCopyOfValue(JsonParser p)	Convenience method, equivalent to:
final TokenBuffer	bufferForInputBuffering()	Convenience method that is equivalent to:
TokenBuffer	bufferForInputBuffering(JsonParser p)	Factory method used for creating TokenBuffer to temporarily contain copy of content read from specified parser; usually for purpose of reading contents later on (possibly augmeneted with injected additional content)
final boolean	canOverrideAccessModifiers()	Convenience method for accessing serialization view in use (if any); equivalent to:
abstract void	checkUnresolvedObjectId()	Method called to ensure that every object id encounter during processing are resolved.
protected ClassIntrospector	classIntrospector()
Calendar	constructCalendar(Date d)	Convenience method for constructing Calendar instance set to specified time, to be modified and used by caller.
JavaType	constructSpecializedType(JavaType baseType, Class<?> subclass)	Convenience method for constructing subtypes, retaining generic type parameter (if any).
final JavaType	constructType(Class<?> cls)	Convenience method, functionally equivalent to:
ArrayTreeNode	createArrayNode()
ObjectTreeNode	createObjectNode()
abstract ValueDeserializer<Object>	deserializerInstance(Annotated annotated, Object deserDef)
String	extractScalarFromObject(JsonParser p, ValueDeserializer<?> deser, Class<?> scalarType)	Method to call in case incoming shape is Object Value (and parser thereby points to JsonToken.START_OBJECT token), but a Scalar value (potentially coercible from String value) is expected.
Class<?>	findClass(String className)	Helper method that is to be used when resolving basic class name into Class instance, the reason being that it may be necessary to work around various ClassLoader limitations, as well as to handle primitive type signatures.
CoercionAction	findCoercionAction(LogicalType targetType, Class<?> targetClass, CoercionInputShape inputShape)	General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested.
CoercionAction	findCoercionFromBlankString(LogicalType targetType, Class<?> targetClass, CoercionAction actionIfBlankNotAllowed)	More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one).
final ValueDeserializer<Object>	findContextualValueDeserializer(JavaType type, BeanProperty prop)	Method for finding a value deserializer, and creating a contextual version if necessary, for value reached via specified property.
final Object	findInjectableValue(Object valueId, BeanProperty forProperty, Object beanInstance, Boolean optional, Boolean useInput)
final KeyDeserializer	findKeyDeserializer(JavaType keyType, BeanProperty prop)
final ValueDeserializer<Object>	findNonContextualValueDeserializer(JavaType type)	Variant that will try to locate deserializer for current type, but without performing any contextualization (unlike findContextualValueDeserializer(tools.jackson.databind.JavaType, tools.jackson.databind.BeanProperty)) or checking for need to create a TypeDeserializer (unlike findRootValueDeserializer(JavaType).
abstract ReadableObjectId	findObjectId(Object id, ObjectIdGenerator<?> generator, ObjectIdResolver resolver)	Method called to find and return entry corresponding to given Object Id: will add an entry if necessary, and never returns null
TypeDeserializer	findPropertyContentTypeDeserializer(JavaType containerType, AnnotatedMember accessor)	Method called to find and create a type information deserializer for values of given container (list, array, map) property, if one is needed.
TypeDeserializer	findPropertyTypeDeserializer(JavaType baseType, AnnotatedMember accessor)	Method called to create a type information deserializer for values of given non-container property, if one is needed.
PropertyName	findRootName(Class<?> rawRootType)
PropertyName	findRootName(JavaType rootType)
final ValueDeserializer<Object>	findRootValueDeserializer(JavaType type)	Method for finding a deserializer for root-level value.
TypeDeserializer	findTypeDeserializer(JavaType baseType)	Method called to find and create a type information deserializer for given base type, if one is needed.
TypeDeserializer	findTypeDeserializer(JavaType baseType, AnnotatedClass classAnnotations)
void	flushCachedDeserializers()	Method that will drop all dynamically constructed deserializers (ones that are counted as result value for DeserializerCache.cachedDeserializersCount()).
final Class<?>	getActiveView()	Accessor for locating currently active view, if any; returns null if no view has been set.
final AnnotationIntrospector	getAnnotationIntrospector()	Convenience method for accessing serialization view in use (if any); equivalent to:
final ArrayBuilders	getArrayBuilders()	Method for accessing object useful for building arrays of primitive types (such as int[]).
Object	getAttribute(Object key)	Method for accessing attributes available in this context.
final Base64Variant	getBase64Variant()	Convenience method for accessing the default Base64 encoding used for decoding base64 encoded binary content.
DeserializationConfig	getConfig()	Accessor to currently active configuration (both per-request configs and per-mapper config).
JavaType	getContextualType()	Accessor to JavaType of currently contextualized ValueDeserializer, if any.
final DatatypeFeatures	getDatatypeFeatures()
final JsonFormat.Value	getDefaultPropertyFormat(Class<?> baseType)
final int	getDeserializationFeatures()	Bulk access method for getting the bit mask of all DeserializationFeatures that are enabled.
int	getFormatReadFeatures(int defaults)
Locale	getLocale()	Method for accessing default Locale to use: convenience method for
final JsonNodeFactory	getNodeFactory()	Convenience method, functionally equivalent to:
final JsonParser	getParser()	Method for accessing the currently active parser.
FormatSchema	getSchema()
int	getStreamReadFeatures(int defaults)
TimeZone	getTimeZone()	Method for accessing default TimeZone to use: convenience method for
final TypeFactory	getTypeFactory()
void	handleBadMerge(ValueDeserializer<?> deser)	Method that deserializer may call if it is called to do an update ("merge") but deserializer operates on a non-mergeable type.
Object	handleInstantiationProblem(Class<?> instClass, Object argument, Throwable t)	Method that deserializers should call if they fail to instantiate value due to an exception that was thrown by constructor (or other mechanism used to create instances).
Object	handleMissingInstantiator(Class<?> instClass, ValueInstantiator valueInst, JsonParser p, String msg, Object... msgArgs)	Method that deserializers should call if they fail to instantiate value due to lack of viable instantiator (usually creator, that is, constructor or static factory method).
JavaType	handleMissingTypeId(JavaType baseType, TypeIdResolver idResolver, String extraDesc)
ValueDeserializer<?>	handlePrimaryContextualization(ValueDeserializer<?> deser, BeanProperty prop, JavaType type)	Method called for primary property deserializers (ones directly created to deserialize values of a POJO property), to handle details of calling ValueDeserializer.createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) with given property context.
ValueDeserializer<?>	handleSecondaryContextualization(ValueDeserializer<?> deser, BeanProperty prop, JavaType type)	Method called for secondary property deserializers (ones NOT directly created to deal with an annotatable POJO property, but instead created as a component -- such as value deserializers for structured types, or deserializers for root values) to handle details of resolving ValueDeserializer.createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) with given property context.
Object	handleUnexpectedToken(Class<?> instClass, JsonParser p)
Object	handleUnexpectedToken(JavaType targetType, JsonParser p)	Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle).
Object	handleUnexpectedToken(JavaType targetType, JsonToken t, JsonParser p, String msg, Object... msgArgs)	Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle).
boolean	handleUnknownProperty(JsonParser p, ValueDeserializer<?> deser, Object instanceOrClass, String propName)	Method that deserializers should call if they encounter an unrecognized property (and once that is not explicitly designed as ignorable), to inform possibly configured DeserializationProblemHandlers and let it handle the problem.
JavaType	handleUnknownTypeId(JavaType baseType, String id, TypeIdResolver idResolver, String extraDesc)	Method that deserializers should call if they encounter a type id (for polymorphic deserialization) that cannot be resolved to an actual type; usually since there is no mapping defined.
Object	handleWeirdKey(Class<?> keyClass, String keyValue, String msg, Object... msgArgs)	Method that deserializers should call if they encounter a String value that cannot be converted to expected key of a Map valued property.
Object	handleWeirdNativeValue(JavaType targetType, Object badValue, JsonParser p)
Object	handleWeirdNumberValue(Class<?> targetClass, Number value, String msg, Object... msgArgs)	Method that deserializers should call if they encounter a numeric value that cannot be converted to target property type, in cases where some numeric values could be acceptable (either with different settings, or different numeric value).
Object	handleWeirdStringValue(Class<?> targetClass, String value, String msg, Object... msgArgs)	Method that deserializers should call if they encounter a String value that cannot be converted to target property type, in cases where some String values could be acceptable (either with different settings, or different value).
final boolean	hasDeserializationFeatures(int featureMask)	Bulk access method for checking that all features specified by mask are enabled.
boolean	hasExplicitDeserializerFor(Class<?> valueType)	Method that can be used to see whether there is an explicitly registered deserializer for given type: this is true for supported JDK types, as well as third-party types for which Module provides support but is NOT true (that is, returns false) for POJO types for which BeanDeserializer is generated based on discovered properties.
final boolean	hasSomeOfFeatures(int featureMask)	Bulk access method for checking that at least one of features specified by mask is enabled.
DatabindException	instantiationException(Class<?> instClass, String msg0)	Helper method for constructing instantiation exception for specified type, to indicate that instantiation failed due to missing instantiator (creator; constructor or factory method).
DatabindException	instantiationException(Class<?> instClass, Throwable cause)	Helper method for constructing instantiation exception for specified type, to indicate problem with physically constructing instance of specified class (missing constructor, exception from constructor)
BeanDescription	introspectBeanDescription(JavaType type, AnnotatedClass ac)
BeanDescription	introspectBeanDescriptionForBuilder(JavaType builderType, BeanDescription valueTypeDesc)
BeanDescription	introspectBeanDescriptionForCreation(JavaType type)
BeanDescription	introspectBeanDescriptionForCreation(JavaType type, AnnotatedClass ac)
DatabindException	invalidTypeIdException(JavaType baseType, String typeId, String extraDesc)	Helper method for constructing exception to indicate that given type id could not be resolved to a valid subtype of specified base type.
final boolean	isEnabled(StreamReadCapability cap)	Accessor for checking whether input format has specified capability or not.
final boolean	isEnabled(DatatypeFeature feature)	Method for checking whether specified datatype feature is enabled or not.
final boolean	isEnabled(DeserializationFeature feat)	Convenience method for checking whether specified on/off feature is enabled
final boolean	isEnabled(MapperFeature feature)	Convenience method for checking whether specified Mapper feature is enabled or not.
abstract KeyDeserializer	keyDeserializerInstance(Annotated annotated, Object deserDef)
BeanDescription.Supplier	lazyIntrospectBeanDescriptionForBuilder(JavaType builderType, BeanDescription valueTypeDesc)
BeanDescription.Supplier	lazyIntrospectBeanDescriptionForCreation(JavaType type)
final ObjectBuffer	leaseObjectBuffer()	Method that can be used to get access to a reusable ObjectBuffer, useful for efficiently constructing Object arrays and Lists.
DatabindException	missingInjectableValueException(String msg, Object valueId, BeanProperty forProperty, Object beanInstance)
DatabindException	missingTypeIdException(JavaType baseType, String extraDesc)
Date	parseDate(String dateStr)	Convenience method for parsing a Date from given String, using currently configured date format (accessed using MapperConfig.getDateFormat()).
<T> T	readPropertyValue(JsonParser p, BeanProperty prop, Class<T> type)	Convenience method that may be used by composite or container deserializers, for reading one-off values for the composite type, taking into account annotations that the property (passed to this method -- usually property that has custom serializer that called this method) has.
<T> T	readPropertyValue(JsonParser p, BeanProperty prop, JavaType type)	Same as readPropertyValue(JsonParser, BeanProperty, Class) but with fully resolved JavaType as target: needs to be used for generic types, for example.
JsonNode	readTree(JsonParser p)
<T> T	readTreeAsValue(JsonNode n, Class<T> targetType)	Helper method similar to ObjectReader.treeToValue(TreeNode, Class) which will read contents of given tree (JsonNode) and bind them into specified target type.
<T> T	readTreeAsValue(JsonNode n, JavaType targetType)	Same as readTreeAsValue(JsonNode, Class) but will fully resolved JavaType as targetType
<T> T	readValue(JsonParser p, Class<T> type)	Convenience method that may be used by composite or container deserializers, for reading one-off values contained (for sequences, it is more efficient to actually fetch deserializer once for the whole collection).
<T> T	readValue(JsonParser p, ResolvedType type)
<T> T	readValue(JsonParser p, TypeReference<T> refType)
<T> T	readValue(JsonParser p, JavaType type)
<T> T	reportBadCoercion(ValueDeserializer<?> src, Class<?> targetType, Object inputValue, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where specific input coercion was not allowed.
<T> T	reportBadDefinition(JavaType type, String msg)	Helper method called to indicate a generic problem that stems from type definition(s), not input data, or input/output state; typically this means throwing a InvalidDefinitionException.
<T> T	reportBadPropertyDefinition(BeanDescription.Supplier beanDescRef, BeanPropertyDefinition prop, String msg, Object... msgArgs)	Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific property (of a type), unrelated to actual JSON content to map.
<T> T	reportBadPropertyDefinition(BeanDescription bean, BeanPropertyDefinition prop, String msg, Object... msgArgs)
<T> T	reportBadTypeDefinition(BeanDescription bean, String msg, Object... msgArgs)	Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific Java type, unrelated to actual JSON content to map.
<T> T	reportInputMismatch(Class<?> targetType, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.
<T> T	reportInputMismatch(BeanProperty prop, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.
<T> T	reportInputMismatch(JavaType targetType, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.
<T> T	reportInputMismatch(ValueDeserializer<?> src, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.
<T> T	reportPropertyInputMismatch(Class<?> targetType, String propertyName, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.
<T> T	reportPropertyInputMismatch(JavaType targetType, String propertyName, String msg, Object... msgArgs)	Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.
<T> T	reportTrailingTokens(Class<?> targetType, JsonParser p, JsonToken trailingToken)
<T> T	reportUnresolvedObjectId(ObjectIdReader oidReader, Object bean)
void	reportWrongTokenException(Class<?> targetType, JsonToken expToken, String msg, Object... msgArgs)	Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.
void	reportWrongTokenException(JavaType targetType, JsonToken expToken, String msg, Object... msgArgs)	Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.
void	reportWrongTokenException(ValueDeserializer<?> deser, JsonToken expToken, String msg, Object... msgArgs)	Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.
final void	returnObjectBuffer(ObjectBuffer buf)	Method to call to return object buffer previously leased with leaseObjectBuffer().
DeserializationContext	setAttribute(Object key, Object value)	Method for setting per-call value of given attribute.
StreamReadConstraints	streamReadConstraints()
TokenStreamFactory	tokenStreamFactory()
DatabindException	weirdKeyException(Class<?> keyClass, String keyValue, String msg)	Helper method for constructing exception to indicate that given JSON Object field name was not in format to be able to deserialize specified key type.
DatabindException	weirdNativeValueException(Object value, Class<?> instClass)	Helper method for constructing exception to indicate that input JSON token of type "native value" (see JsonToken.VALUE_EMBEDDED_OBJECT) is of incompatible type (and there is no delegating creator or such to use) and cannot be used to construct value of specified type (usually POJO).
DatabindException	weirdNumberException(Number value, Class<?> instClass, String msg)	Helper method for constructing exception to indicate that input JSON Number was not suitable for deserializing into given target type.
DatabindException	weirdStringException(String value, Class<?> instClass, String msgBase)	Helper method for constructing exception to indicate that input JSON String was not suitable for deserializing into given target type.
DatabindException	wrongTokenException(JsonParser p, Class<?> targetType, JsonToken expToken, String extra)
DatabindException	wrongTokenException(JsonParser p, JavaType targetType, JsonToken expToken, String extra)	Helper method for constructing DatabindException to indicate that the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens.

Methods inherited from class tools.jackson.databind.DatabindContext

_colonConcat, _desc, _format, _quotedString, _throwNotASubtype, _throwSubtypeClassNotAllowed, _throwSubtypeNameNotAllowed, _truncate, constructType, converterInstance, introspectBeanDescription, introspectClassAnnotations, introspectClassAnnotations, introspectDirectClassAnnotations, isAnnotationProcessingEnabled, lazyIntrospectBeanDescription, objectIdGeneratorInstance, objectIdResolverInstance, reportBadDefinition, reportBadTypeDefinition, resolveAndValidateSubType, resolveSubType

Methods inherited from class java.lang.Object

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

Methods inherited from interface tools.jackson.core.ObjectReadContext

createParser, createParser, createParser, createParser, createParser, treeAsTokens

Field Details

_streamFactory

protected final TokenStreamFactory _streamFactory

Low-level TokenStreamFactory that may be used for constructing embedded parsers.

_factory

protected final DeserializerFactory _factory

Read-only factory instance; exposed to let owners (ObjectMapper, ObjectReader) access it.

_cache

protected final DeserializerCache _cache

Object that handle details of ValueDeserializer caching.

_config

protected final DeserializationConfig _config

Generic deserialization processing configuration

_featureFlags

protected final int _featureFlags

Bitmap of DeserializationFeatures that are enabled

_activeView

protected final Class<?> _activeView

Currently active view, if any.

_schema

protected final FormatSchema _schema

Schema for underlying parser to use, if any.

_injectableValues

protected final InjectableValues _injectableValues

Object used for resolving references to injectable values.

_parser

protected transient JsonParser _parser

Currently active parser used for deserialization. May be different from the outermost parser when content is buffered.

_readCapabilities

protected transient JacksonFeatureSet<StreamReadCapability> _readCapabilities

Capabilities of the input format.

_arrayBuilders

protected transient ArrayBuilders _arrayBuilders

_objectBuffer

protected transient ObjectBuffer _objectBuffer

_dateFormat

protected transient DateFormat _dateFormat

_attributes

protected transient ContextAttributes _attributes

Lazily-constructed holder for per-call attributes.

_currentType

protected LinkedNode<JavaType> _currentType

Type of ValueDeserializer on which ValueDeserializer.createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) is being called currently.

_classIntrospector

protected transient ClassIntrospector _classIntrospector

Lazily constructed ClassIntrospector instance: created from "blueprint"

Constructor Details

DeserializationContext

protected DeserializationContext(TokenStreamFactory streamFactory,
 DeserializerFactory df,
 DeserializerCache cache,
 DeserializationConfig config,
 FormatSchema schema,
 InjectableValues injectableValues)

Method Details

getConfig

public DeserializationConfig getConfig()

Description copied from class: DatabindContext

Accessor to currently active configuration (both per-request configs and per-mapper config).

Specified by:

getConfig in class DatabindContext

getActiveView

public final Class<?> getActiveView()

Description copied from class: DatabindContext

Accessor for locating currently active view, if any; returns null if no view has been set.

Specified by:

getActiveView in class DatabindContext

canOverrideAccessModifiers

public final boolean canOverrideAccessModifiers()

Description copied from class: DatabindContext

Convenience method for accessing serialization view in use (if any); equivalent to:

   getConfig().canOverrideAccessModifiers();

Specified by:

canOverrideAccessModifiers in class DatabindContext

isEnabled

public final boolean isEnabled(MapperFeature feature)

Description copied from class: DatabindContext

Convenience method for checking whether specified Mapper feature is enabled or not. Shortcut for:

  getConfig().isEnabled(feature);

Specified by:

isEnabled in class DatabindContext

isEnabled

public final boolean isEnabled(DatatypeFeature feature)

Description copied from class: DatabindContext

Method for checking whether specified datatype feature is enabled or not.

Specified by:

isEnabled in class DatabindContext

getDatatypeFeatures

public final DatatypeFeatures getDatatypeFeatures()

Specified by:

getDatatypeFeatures in class DatabindContext

getDefaultPropertyFormat

public final JsonFormat.Value getDefaultPropertyFormat(Class<?> baseType)

Specified by:

getDefaultPropertyFormat in class DatabindContext

getAnnotationIntrospector

public final AnnotationIntrospector getAnnotationIntrospector()

Description copied from class: DatabindContext

Convenience method for accessing serialization view in use (if any); equivalent to:

   getConfig().getAnnotationIntrospector();

Specified by:

getAnnotationIntrospector in class DatabindContext

getTypeFactory

public final TypeFactory getTypeFactory()

Specified by:

getTypeFactory in class DatabindContext

constructSpecializedType

public JavaType constructSpecializedType(JavaType baseType,
 Class<?> subclass)
                                  throws IllegalArgumentException

Description copied from class: DatabindContext

Convenience method for constructing subtypes, retaining generic type parameter (if any).

Note: since 2.11 handling has varied a bit across serialization, deserialization.

Specified by:

constructSpecializedType in class DatabindContext

Throws:

IllegalArgumentException

getLocale

public Locale getLocale()

Method for accessing default Locale to use: convenience method for

   getConfig().getLocale();

Specified by:

getLocale in class DatabindContext

getTimeZone

public TimeZone getTimeZone()

Method for accessing default TimeZone to use: convenience method for

   getConfig().getTimeZone();

Specified by:

getTimeZone in class DatabindContext

getAttribute

public Object getAttribute(Object key)

Description copied from class: DatabindContext

Method for accessing attributes available in this context. Per-call attributes have highest precedence; attributes set via ObjectReader or ObjectWriter have lower precedence.

Specified by:

getAttribute in class DatabindContext

Parameters:

key - Key of the attribute to get

Returns:

Value of the attribute, if any; null otherwise

setAttribute

public DeserializationContext setAttribute(Object key,
 Object value)

Description copied from class: DatabindContext

Method for setting per-call value of given attribute. This will override any previously defined value for the attribute within this context.

Specified by:

setAttribute in class DatabindContext

Parameters:

key - Key of the attribute to set

value - Value to set attribute to

Returns:

This context object, to allow chaining

getContextualType

public JavaType getContextualType()

Accessor to JavaType of currently contextualized ValueDeserializer, if any. This is sometimes useful for generic ValueDeserializers that do not get passed (or do not retain) type information when being constructed: happens for example for deserializers constructed from annotations.

Returns:

Type of ValueDeserializer being contextualized, if process is on-going; null if not.

tokenStreamFactory

public TokenStreamFactory tokenStreamFactory()

Specified by:

tokenStreamFactory in interface ObjectReadContext

getSchema

public FormatSchema getSchema()

Specified by:

getSchema in interface ObjectReadContext

streamReadConstraints

public StreamReadConstraints streamReadConstraints()

Specified by:

streamReadConstraints in interface ObjectReadContext

getStreamReadFeatures

public int getStreamReadFeatures(int defaults)

Specified by:

getStreamReadFeatures in interface ObjectReadContext

getFormatReadFeatures

public int getFormatReadFeatures(int defaults)

Specified by:

getFormatReadFeatures in interface ObjectReadContext

createArrayNode

public ArrayTreeNode createArrayNode()

Specified by:

createArrayNode in interface ObjectReadContext

createObjectNode

public ObjectTreeNode createObjectNode()

Specified by:

createObjectNode in interface ObjectReadContext

readTree

public JsonNode readTree(JsonParser p)
                  throws JacksonException

Specified by:

readTree in interface ObjectReadContext

Throws:

JacksonException

readValue

public <T> T readValue(JsonParser p,
 Class<T> type)
                throws JacksonException

Convenience method that may be used by composite or container deserializers, for reading one-off values contained (for sequences, it is more efficient to actually fetch deserializer once for the whole collection).

NOTE: when deserializing values of properties contained in composite types, rather use readPropertyValue(JsonParser, BeanProperty, Class); this method does not allow use of contextual annotations.

Specified by:

readValue in interface ObjectReadContext

Throws:

JacksonException

readValue

public <T> T readValue(JsonParser p,
 TypeReference<T> refType)
                throws JacksonException

Specified by:

readValue in interface ObjectReadContext

Throws:

JacksonException

readValue

public <T> T readValue(JsonParser p,
 ResolvedType type)
                throws JacksonException

Specified by:

readValue in interface ObjectReadContext

Throws:

JacksonException

readValue

public <T> T readValue(JsonParser p,
 JavaType type)
                throws JacksonException

Throws:

JacksonException

isEnabled

public final boolean isEnabled(DeserializationFeature feat)

Convenience method for checking whether specified on/off feature is enabled

getDeserializationFeatures

public final int getDeserializationFeatures()

Bulk access method for getting the bit mask of all DeserializationFeatures that are enabled.

hasDeserializationFeatures

public final boolean hasDeserializationFeatures(int featureMask)

Bulk access method for checking that all features specified by mask are enabled.

hasSomeOfFeatures

public final boolean hasSomeOfFeatures(int featureMask)

Bulk access method for checking that at least one of features specified by mask is enabled.

isEnabled

public final boolean isEnabled(StreamReadCapability cap)

Accessor for checking whether input format has specified capability or not.

Returns:

True if input format has specified capability; false if not

getParser

public final JsonParser getParser()

Method for accessing the currently active parser. May be different from the outermost parser when content is buffered.

Use of this method is discouraged: if code has direct access to the active parser, that should be used instead.

findInjectableValue

public final Object findInjectableValue(Object valueId,
 BeanProperty forProperty,
 Object beanInstance,
 Boolean optional,
 Boolean useInput)

getBase64Variant

public final Base64Variant getBase64Variant()

Convenience method for accessing the default Base64 encoding used for decoding base64 encoded binary content. Same as calling:

  getConfig().getBase64Variant();

getNodeFactory

public final JsonNodeFactory getNodeFactory()

Convenience method, functionally equivalent to:

  getConfig().getNodeFactory();
 

classIntrospector

protected ClassIntrospector classIntrospector()

Specified by:

classIntrospector in class DatabindContext

introspectBeanDescription

public BeanDescription introspectBeanDescription(JavaType type,
 AnnotatedClass ac)

Specified by:

introspectBeanDescription in class DatabindContext

introspectBeanDescriptionForCreation

public BeanDescription introspectBeanDescriptionForCreation(JavaType type)

introspectBeanDescriptionForCreation

public BeanDescription introspectBeanDescriptionForCreation(JavaType type,
 AnnotatedClass ac)

lazyIntrospectBeanDescriptionForCreation

public BeanDescription.Supplier lazyIntrospectBeanDescriptionForCreation(JavaType type)

introspectBeanDescriptionForBuilder

public BeanDescription introspectBeanDescriptionForBuilder(JavaType builderType,
 BeanDescription valueTypeDesc)

lazyIntrospectBeanDescriptionForBuilder

public BeanDescription.Supplier lazyIntrospectBeanDescriptionForBuilder(JavaType builderType,
 BeanDescription valueTypeDesc)

findRootName

public PropertyName findRootName(JavaType rootType)

Specified by:

findRootName in class DatabindContext

findRootName

public PropertyName findRootName(Class<?> rawRootType)

Specified by:

findRootName in class DatabindContext

hasExplicitDeserializerFor

public boolean hasExplicitDeserializerFor(Class<?> valueType)

Method that can be used to see whether there is an explicitly registered deserializer for given type: this is true for supported JDK types, as well as third-party types for which Module provides support but is NOT true (that is, returns false) for POJO types for which BeanDeserializer is generated based on discovered properties.

Note that it is up to Modules to implement support for this method: some do (like basic SimpleModule).

Parameters:

valueType - Type-erased type to check

Returns:

True if this factory has explicit (non-POJO) deserializer for specified type, or has a provider (of type Deserializers) that has.

findCoercionAction

public CoercionAction findCoercionAction(LogicalType targetType,
 Class<?> targetClass,
 CoercionInputShape inputShape)

General-purpose accessor for finding what to do when specified coercion from shape that is now always allowed to be coerced from is requested.

Parameters:

targetType - Logical target type of coercion

targetClass - Physical target type of coercion

inputShape - Input shape to coerce from

Returns:

CoercionAction configured for specific coercion

findCoercionFromBlankString

public CoercionAction findCoercionFromBlankString(LogicalType targetType,
 Class<?> targetClass,
 CoercionAction actionIfBlankNotAllowed)

More specialized accessor called in case of input being a blank String (one consisting of only white space characters with length of at least one). Will basically first determine if "blank as empty" is allowed: if not, returns actionIfBlankNotAllowed, otherwise returns action for CoercionInputShape.EmptyString.

Parameters:

targetType - Logical target type of coercion

targetClass - Physical target type of coercion

actionIfBlankNotAllowed - Return value to use in case "blanks as empty" is not allowed

Returns:

CoercionAction configured for specified coercion from blank string

bufferForInputBuffering

public TokenBuffer bufferForInputBuffering(JsonParser p)

Factory method used for creating TokenBuffer to temporarily contain copy of content read from specified parser; usually for purpose of reading contents later on (possibly augmeneted with injected additional content)

bufferForInputBuffering

public final TokenBuffer bufferForInputBuffering()

Convenience method that is equivalent to:

   ctxt.bufferForInputBuffering(ctxt.getParser());

bufferAsCopyOfValue

public TokenBuffer bufferAsCopyOfValue(JsonParser p)
                                throws JacksonException

Convenience method, equivalent to:

 TokenBuffer buffer = ctxt.bufferForInputBuffering(parser);
 buffer.copyCurrentStructure(parser);
 return buffer;

NOTE: the whole "current value" that parser points to is read and buffered, including Object and Array values (if parser pointing to start marker).

Throws:

JacksonException

findContextualValueDeserializer

public final ValueDeserializer<Object> findContextualValueDeserializer(JavaType type,
 BeanProperty prop)

Method for finding a value deserializer, and creating a contextual version if necessary, for value reached via specified property.

findNonContextualValueDeserializer

public final ValueDeserializer<Object> findNonContextualValueDeserializer(JavaType type)

Variant that will try to locate deserializer for current type, but without performing any contextualization (unlike findContextualValueDeserializer(tools.jackson.databind.JavaType, tools.jackson.databind.BeanProperty)) or checking for need to create a TypeDeserializer (unlike findRootValueDeserializer(JavaType). This method is usually called from within ValueDeserializer.resolve(tools.jackson.databind.DeserializationContext), and expectation is that caller then calls either handlePrimaryContextualization(ValueDeserializer, BeanProperty, JavaType) or handleSecondaryContextualization(ValueDeserializer, BeanProperty, JavaType) at a later point, as necessary.

findRootValueDeserializer

public final ValueDeserializer<Object> findRootValueDeserializer(JavaType type)

Method for finding a deserializer for root-level value.

findTypeDeserializer

public TypeDeserializer findTypeDeserializer(JavaType baseType)

Method called to find and create a type information deserializer for given base type, if one is needed. If not needed (no polymorphic handling configured for type), should return null.

Note that this method is usually only directly called for values of container (Collection, array, Map) types and root values, but not for bean property values.

Parameters:

baseType - Declared base type of the value to deserializer (actual deserializer type will be this type or its subtype)

Returns:

Type deserializer to use for given base type, if one is needed; null if not.

findTypeDeserializer

public TypeDeserializer findTypeDeserializer(JavaType baseType,
 AnnotatedClass classAnnotations)

findPropertyTypeDeserializer

public TypeDeserializer findPropertyTypeDeserializer(JavaType baseType,
 AnnotatedMember accessor)

Method called to create a type information deserializer for values of given non-container property, if one is needed. If not needed (no polymorphic handling configured for property), should return null.

Note that this method is only called for non-container bean properties, and not for values in container types or root values (or container properties)

Parameters:

baseType - Declared base type of the value to deserializer (actual deserializer type will be this type or its subtype)

Returns:

Type deserializer to use for given base type, if one is needed; null if not.

Since:

3.0

findPropertyContentTypeDeserializer

public TypeDeserializer findPropertyContentTypeDeserializer(JavaType containerType,
 AnnotatedMember accessor)

Method called to find and create a type information deserializer for values of given container (list, array, map) property, if one is needed. If not needed (no polymorphic handling configured for property), should return null.

Note that this method is only called for container bean properties, and not for values in container types or root values (or non-container properties)

Parameters:

containerType - Type of property; must be a container type

accessor - Field or method that contains container property

Since:

3.0

findKeyDeserializer

public final KeyDeserializer findKeyDeserializer(JavaType keyType,
 BeanProperty prop)

flushCachedDeserializers

public void flushCachedDeserializers()

Method that will drop all dynamically constructed deserializers (ones that are counted as result value for DeserializerCache.cachedDeserializersCount()). This can be used to remove memory usage (in case some deserializers are only used once or so), or to force re-construction of deserializers after configuration changes for mapper than owns the provider.

Since:

2.19

findObjectId

public abstract ReadableObjectId findObjectId(Object id,
 ObjectIdGenerator<?> generator,
 ObjectIdResolver resolver)

Method called to find and return entry corresponding to given Object Id: will add an entry if necessary, and never returns null

checkUnresolvedObjectId

public abstract void checkUnresolvedObjectId()
                                      throws UnresolvedForwardReference

Method called to ensure that every object id encounter during processing are resolved.

Throws:

UnresolvedForwardReference

constructType

public final JavaType constructType(Class<?> cls)

Convenience method, functionally equivalent to:

  getConfig().constructType(cls);
 

findClass

public Class<?> findClass(String className)
                   throws ClassNotFoundException

Helper method that is to be used when resolving basic class name into Class instance, the reason being that it may be necessary to work around various ClassLoader limitations, as well as to handle primitive type signatures.

Throws:

ClassNotFoundException

leaseObjectBuffer

public final ObjectBuffer leaseObjectBuffer()

Method that can be used to get access to a reusable ObjectBuffer, useful for efficiently constructing Object arrays and Lists. Note that leased buffers should be returned once deserializer is done, to allow for reuse during same round of deserialization.

returnObjectBuffer

public final void returnObjectBuffer(ObjectBuffer buf)

Method to call to return object buffer previously leased with leaseObjectBuffer().

Parameters:

buf - Returned object buffer

getArrayBuilders

public final ArrayBuilders getArrayBuilders()

Method for accessing object useful for building arrays of primitive types (such as int[]).

deserializerInstance

public abstract ValueDeserializer<Object> deserializerInstance(Annotated annotated,
 Object deserDef)

keyDeserializerInstance

public abstract KeyDeserializer keyDeserializerInstance(Annotated annotated,
 Object deserDef)

handlePrimaryContextualization

public ValueDeserializer<?> handlePrimaryContextualization(ValueDeserializer<?> deser,
 BeanProperty prop,
 JavaType type)

Method called for primary property deserializers (ones directly created to deserialize values of a POJO property), to handle details of calling ValueDeserializer.createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) with given property context.

Parameters:

prop - Property for which the given primary deserializer is used; never null.

handleSecondaryContextualization

public ValueDeserializer<?> handleSecondaryContextualization(ValueDeserializer<?> deser,
 BeanProperty prop,
 JavaType type)

Method called for secondary property deserializers (ones NOT directly created to deal with an annotatable POJO property, but instead created as a component -- such as value deserializers for structured types, or deserializers for root values) to handle details of resolving ValueDeserializer.createContextual(tools.jackson.databind.DeserializationContext, tools.jackson.databind.BeanProperty) with given property context. Given that these deserializers are not directly related to given property (or, in case of root value property, to any property), annotations accessible may or may not be relevant.

Parameters:

prop - Property for which deserializer is used, if any; null when deserializing root values

parseDate

public Date parseDate(String dateStr)
               throws IllegalArgumentException

Convenience method for parsing a Date from given String, using currently configured date format (accessed using MapperConfig.getDateFormat()).

Implementation will handle thread-safety issues related to date formats such that first time this method is called, date format is cloned, and cloned instance will be retained for use during this deserialization round.

Throws:

IllegalArgumentException

constructCalendar

public Calendar constructCalendar(Date d)

Convenience method for constructing Calendar instance set to specified time, to be modified and used by caller.

extractScalarFromObject

public String extractScalarFromObject(JsonParser p,
 ValueDeserializer<?> deser,
 Class<?> scalarType)
                               throws JacksonException

Method to call in case incoming shape is Object Value (and parser thereby points to JsonToken.START_OBJECT token), but a Scalar value (potentially coercible from String value) is expected. This would typically be used to deserialize a Number, Boolean value or some other "simple" unstructured value type.

Note that expected behavior in case of extraction not succeeding changed in Jackson 2.20: now null is expected to be returned in that case (in 2.19 and before, exception was to be thrown, but this prevented fallback handling via DeserializationProblemHandler.handleUnexpectedToken(tools.jackson.databind.DeserializationContext, tools.jackson.databind.JavaType, tools.jackson.core.JsonToken, tools.jackson.core.JsonParser, java.lang.String).

Parameters:

p - Actual parser to read content from

deser - Deserializer that needs extracted String value

scalarType - Immediate type of scalar to extract; usually type deserializer handles but not always (for example, deserializer for int[] would pass scalar type of int)

Returns:

String value found, if any; null if none (note: changed in 2.20; before that in 2.19 and before exception throwing was expected)

Throws:

JacksonException - If there are problems either reading content (underlying parser problem) or finding expected scalar value

readPropertyValue

public <T> T readPropertyValue(JsonParser p,
 BeanProperty prop,
 Class<T> type)
                        throws JacksonException

Convenience method that may be used by composite or container deserializers, for reading one-off values for the composite type, taking into account annotations that the property (passed to this method -- usually property that has custom serializer that called this method) has.

Parameters:

p - Parser that points to the first token of the value to read

prop - Logical property of a POJO being type

Returns:

Value of type type that was read

Throws:

JacksonException

readPropertyValue

public <T> T readPropertyValue(JsonParser p,
 BeanProperty prop,
 JavaType type)
                        throws JacksonException

Same as readPropertyValue(JsonParser, BeanProperty, Class) but with fully resolved JavaType as target: needs to be used for generic types, for example.

Throws:

JacksonException

readTreeAsValue

public <T> T readTreeAsValue(JsonNode n,
 Class<T> targetType)
                      throws JacksonException

Helper method similar to ObjectReader.treeToValue(TreeNode, Class) which will read contents of given tree (JsonNode) and bind them into specified target type. This is often used in two-phase deserialization in which content is first read as a tree, then manipulated (adding and/or removing properties of Object values, for example), and finally converted into actual target type using default deserialization logic for the type.

NOTE: deserializer implementations should be careful not to try to recursively deserialize into target type deserializer has registered itself to handle.

Parameters:

n - Tree value to convert, if not null: if null, will simply return null

targetType - Type to deserialize contents of n into (if n not null)

Returns:

Either null (if n was null or a value of type type that was read from non-null n argument

Throws:

JacksonException

readTreeAsValue

public <T> T readTreeAsValue(JsonNode n,
 JavaType targetType)
                      throws JacksonException

Same as readTreeAsValue(JsonNode, Class) but will fully resolved JavaType as targetType

NOTE: deserializer implementations should be careful not to try to recursively deserialize into target type deserializer has registered itself to handle.

Parameters:

n - Tree value to convert

targetType - Type to deserialize contents of n into

Returns:

Value of type type that was read

Throws:

JacksonException

handleUnknownProperty

public boolean handleUnknownProperty(JsonParser p,
 ValueDeserializer<?> deser,
 Object instanceOrClass,
 String propName)
                              throws JacksonException

Method that deserializers should call if they encounter an unrecognized property (and once that is not explicitly designed as ignorable), to inform possibly configured DeserializationProblemHandlers and let it handle the problem.

Returns:

True if there was a configured problem handler that was able to handle the problem

Throws:

JacksonException

handleWeirdKey

public Object handleWeirdKey(Class<?> keyClass,
 String keyValue,
 String msg,
 Object... msgArgs)
                      throws JacksonException

Method that deserializers should call if they encounter a String value that cannot be converted to expected key of a Map valued property. Default implementation will try to call DeserializationProblemHandler.handleWeirdNumberValue(tools.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.Number, java.lang.String) on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw InvalidFormatException with given message.

Parameters:

keyClass - Expected type for key

keyValue - String value from which to deserialize key

msg - Error message template caller wants to use if exception is to be thrown

msgArgs - Optional arguments to use for message, if any

Returns:

Key value to use

Throws:

JacksonException - To indicate unrecoverable problem, usually based on msg

handleWeirdStringValue

public Object handleWeirdStringValue(Class<?> targetClass,
 String value,
 String msg,
 Object... msgArgs)
                              throws JacksonException

Method that deserializers should call if they encounter a String value that cannot be converted to target property type, in cases where some String values could be acceptable (either with different settings, or different value). Default implementation will try to call DeserializationProblemHandler.handleWeirdStringValue(tools.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.String, java.lang.String) on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw InvalidFormatException with given message.

Parameters:

targetClass - Type of property into which incoming String should be converted

value - String value from which to deserialize property value

msg - Error message template caller wants to use if exception is to be thrown

msgArgs - Optional arguments to use for message, if any

Returns:

Property value to use

Throws:

JacksonException - To indicate unrecoverable problem, usually based on msg

handleWeirdNumberValue

public Object handleWeirdNumberValue(Class<?> targetClass,
 Number value,
 String msg,
 Object... msgArgs)
                              throws JacksonException

Method that deserializers should call if they encounter a numeric value that cannot be converted to target property type, in cases where some numeric values could be acceptable (either with different settings, or different numeric value). Default implementation will try to call DeserializationProblemHandler.handleWeirdNumberValue(tools.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.Number, java.lang.String) on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw InvalidFormatException with given message.

Parameters:

targetClass - Type of property into which incoming number should be converted

value - Number value from which to deserialize property value

msg - Error message template caller wants to use if exception is to be thrown

msgArgs - Optional arguments to use for message, if any

Returns:

Property value to use

Throws:

JacksonException - To indicate unrecoverable problem, usually based on msg

handleWeirdNativeValue

public Object handleWeirdNativeValue(JavaType targetType,
 Object badValue,
 JsonParser p)
                              throws JacksonException

Throws:

JacksonException

handleMissingInstantiator

public Object handleMissingInstantiator(Class<?> instClass,
 ValueInstantiator valueInst,
 JsonParser p,
 String msg,
 Object... msgArgs)
                                 throws JacksonException

Method that deserializers should call if they fail to instantiate value due to lack of viable instantiator (usually creator, that is, constructor or static factory method). Method should be called at point where value has not been decoded, so that handler has a chance to handle decoding using alternate mechanism, and handle underlying content (possibly by just skipping it) to keep input state valid

Parameters:

instClass - Type that was to be instantiated

valueInst - (optional) Value instantiator to be used, if any; null if type does not use one for instantiation (custom deserialiers don't; standard POJO deserializer does)

p - Parser that points to the JSON value to decode

Returns:

Object that should be constructed, if any; has to be of type instClass

Throws:

JacksonException

handleInstantiationProblem

public Object handleInstantiationProblem(Class<?> instClass,
 Object argument,
 Throwable t)
                                  throws JacksonException

Method that deserializers should call if they fail to instantiate value due to an exception that was thrown by constructor (or other mechanism used to create instances). Default implementation will try to call DeserializationProblemHandler.handleInstantiationProblem(tools.jackson.databind.DeserializationContext, java.lang.Class<?>, java.lang.Object, java.lang.Throwable) on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw exception constructed with instantiationException(java.lang.Class<?>, java.lang.Throwable).

Parameters:

instClass - Type that was to be instantiated

argument - (optional) Argument that was passed to constructor or equivalent instantiator; often a String.

t - Exception that caused failure

Returns:

Object that should be constructed, if any; has to be of type instClass

Throws:

JacksonException

handleUnexpectedToken

public Object handleUnexpectedToken(Class<?> instClass,
 JsonParser p)
                             throws JacksonException

Throws:

JacksonException

handleUnexpectedToken

public Object handleUnexpectedToken(JavaType targetType,
 JsonParser p)
                             throws JacksonException

Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle). This could occur, for example, if a Number deserializer encounter JsonToken.START_ARRAY instead of JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT.

Parameters:

targetType - Type that was to be instantiated

p - Parser that points to the JSON value to decode

Returns:

Object that should be constructed, if any; has to be of type instClass

Throws:

JacksonException

handleUnexpectedToken

public Object handleUnexpectedToken(JavaType targetType,
 JsonToken t,
 JsonParser p,
 String msg,
 Object... msgArgs)
                             throws JacksonException

Method that deserializers should call if the first token of the value to deserialize is of unexpected type (that is, type of token that deserializer cannot handle). This could occur, for example, if a Number deserializer encounter JsonToken.START_ARRAY instead of JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT.

Parameters:

targetType - Type that was to be instantiated

t - Token encountered that does not match expected

p - Parser that points to the JSON value to decode

Returns:

Object that should be constructed, if any; has to be of type instClass

Throws:

JacksonException

handleUnknownTypeId

public JavaType handleUnknownTypeId(JavaType baseType,
 String id,
 TypeIdResolver idResolver,
 String extraDesc)
                             throws JacksonException

Method that deserializers should call if they encounter a type id (for polymorphic deserialization) that cannot be resolved to an actual type; usually since there is no mapping defined. Default implementation will try to call DeserializationProblemHandler.handleUnknownTypeId(tools.jackson.databind.DeserializationContext, tools.jackson.databind.JavaType, java.lang.String, tools.jackson.databind.jsontype.TypeIdResolver, java.lang.String) on configured handlers, if any, to allow for recovery; if recovery does not succeed, will throw exception constructed with invalidTypeIdException(tools.jackson.databind.JavaType, java.lang.String, java.lang.String).

Parameters:

baseType - Base type from which resolution starts

id - Type id that could not be converted

extraDesc - Additional problem description to add to default exception message, if resolution fails.

Returns:

JavaType that id resolves to

Throws:

JacksonException - To indicate unrecoverable problem, if resolution cannot be made to work

handleMissingTypeId

public JavaType handleMissingTypeId(JavaType baseType,
 TypeIdResolver idResolver,
 String extraDesc)
                             throws JacksonException

Throws:

JacksonException

handleBadMerge

public void handleBadMerge(ValueDeserializer<?> deser)
                    throws DatabindException

Method that deserializer may call if it is called to do an update ("merge") but deserializer operates on a non-mergeable type. Although this should usually be caught earlier, sometimes it may only be caught during operation and if so this is the method to call. Note that if MapperFeature.IGNORE_MERGE_FOR_UNMERGEABLE is enabled, this method will simply return null; otherwise InvalidDefinitionException will be thrown.

Throws:

DatabindException

_isCompatible

protected boolean _isCompatible(Class<?> target,
 Object value)

reportWrongTokenException

public void reportWrongTokenException(ValueDeserializer<?> deser,
 JsonToken expToken,
 String msg,
 Object... msgArgs)
                               throws DatabindException

Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that this method will throw a DatabindException and no recovery is attempted (via DeserializationProblemHandler, as problem is considered to be difficult to recover from, in general.

Throws:

DatabindException

reportWrongTokenException

public void reportWrongTokenException(JavaType targetType,
 JsonToken expToken,
 String msg,
 Object... msgArgs)
                               throws DatabindException

Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that this method will throw a DatabindException and no recovery is attempted (via DeserializationProblemHandler, as problem is considered to be difficult to recover from, in general.

Throws:

DatabindException

reportWrongTokenException

public void reportWrongTokenException(Class<?> targetType,
 JsonToken expToken,
 String msg,
 Object... msgArgs)
                               throws DatabindException

Method for deserializers to call when the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that this method will throw a DatabindException and no recovery is attempted (via DeserializationProblemHandler, as problem is considered to be difficult to recover from, in general.

Throws:

DatabindException

reportUnresolvedObjectId

public <T> T reportUnresolvedObjectId(ObjectIdReader oidReader,
 Object bean)
                               throws DatabindException

Throws:

DatabindException

reportInputMismatch

public <T> T reportInputMismatch(ValueDeserializer<?> src,
 String msg,
 Object... msgArgs)
                          throws DatabindException

Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.

Throws:

DatabindException

reportInputMismatch

public <T> T reportInputMismatch(Class<?> targetType,
 String msg,
 Object... msgArgs)
                          throws DatabindException

Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.

Throws:

DatabindException

reportInputMismatch

public <T> T reportInputMismatch(JavaType targetType,
 String msg,
 Object... msgArgs)
                          throws DatabindException

Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.

Throws:

DatabindException

reportInputMismatch

public <T> T reportInputMismatch(BeanProperty prop,
 String msg,
 Object... msgArgs)
                          throws DatabindException

Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.

Throws:

DatabindException

reportPropertyInputMismatch

public <T> T reportPropertyInputMismatch(Class<?> targetType,
 String propertyName,
 String msg,
 Object... msgArgs)
                                  throws DatabindException

Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.

Throws:

DatabindException

reportPropertyInputMismatch

public <T> T reportPropertyInputMismatch(JavaType targetType,
 String propertyName,
 String msg,
 Object... msgArgs)
                                  throws DatabindException

Helper method used to indicate a problem with input in cases where more specific reportXxx() method was not available.

Throws:

DatabindException

reportBadCoercion

public <T> T reportBadCoercion(ValueDeserializer<?> src,
 Class<?> targetType,
 Object inputValue,
 String msg,
 Object... msgArgs)
                        throws DatabindException

Helper method used to indicate a problem with input in cases where specific input coercion was not allowed.

Throws:

DatabindException

reportTrailingTokens

public <T> T reportTrailingTokens(Class<?> targetType,
 JsonParser p,
 JsonToken trailingToken)
                           throws DatabindException

Throws:

DatabindException

reportBadTypeDefinition

public <T> T reportBadTypeDefinition(BeanDescription bean,
 String msg,
 Object... msgArgs)
                              throws DatabindException

Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific Java type, unrelated to actual JSON content to map. Default behavior is to construct and throw a DatabindException.

Specified by:

reportBadTypeDefinition in class DatabindContext

Throws:

DatabindException

reportBadPropertyDefinition

public <T> T reportBadPropertyDefinition(BeanDescription.Supplier beanDescRef,
 BeanPropertyDefinition prop,
 String msg,
 Object... msgArgs)
                                  throws DatabindException

Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific property (of a type), unrelated to actual JSON content to map. Default behavior is to construct and throw a DatabindException.

Throws:

DatabindException

reportBadPropertyDefinition

public <T> T reportBadPropertyDefinition(BeanDescription bean,
 BeanPropertyDefinition prop,
 String msg,
 Object... msgArgs)
                                  throws DatabindException

Throws:

DatabindException

reportBadDefinition

public <T> T reportBadDefinition(JavaType type,
 String msg)
                          throws DatabindException

Description copied from class: DatabindContext

Helper method called to indicate a generic problem that stems from type definition(s), not input data, or input/output state; typically this means throwing a InvalidDefinitionException.

Specified by:

reportBadDefinition in class DatabindContext

Throws:

DatabindException

wrongTokenException

public DatabindException wrongTokenException(JsonParser p,
 JavaType targetType,
 JsonToken expToken,
 String extra)

Helper method for constructing DatabindException to indicate that the token encountered was of type different than what should be seen at that position, usually within a sequence of expected tokens. Note that most of the time this method should NOT be directly called; instead, reportWrongTokenException(tools.jackson.databind.ValueDeserializer<?>, tools.jackson.core.JsonToken, java.lang.String, java.lang.Object...) should be called and will call this method as necessary.

wrongTokenException

public DatabindException wrongTokenException(JsonParser p,
 Class<?> targetType,
 JsonToken expToken,
 String extra)

weirdKeyException

public DatabindException weirdKeyException(Class<?> keyClass,
 String keyValue,
 String msg)

Helper method for constructing exception to indicate that given JSON Object field name was not in format to be able to deserialize specified key type. Note that most of the time this method should NOT be called; instead, handleWeirdKey(java.lang.Class<?>, java.lang.String, java.lang.String, java.lang.Object...) should be called which will call this method if necessary.

weirdStringException

public DatabindException weirdStringException(String value,
 Class<?> instClass,
 String msgBase)

Helper method for constructing exception to indicate that input JSON String was not suitable for deserializing into given target type. Note that most of the time this method should NOT be called; instead, handleWeirdStringValue(java.lang.Class<?>, java.lang.String, java.lang.String, java.lang.Object...) should be called which will call this method if necessary.

Parameters:

value - String value from input being deserialized

instClass - Type that String should be deserialized into

msgBase - Message that describes specific problem

weirdNumberException

public DatabindException weirdNumberException(Number value,
 Class<?> instClass,
 String msg)

Helper method for constructing exception to indicate that input JSON Number was not suitable for deserializing into given target type. Note that most of the time this method should NOT be called; instead, handleWeirdNumberValue(java.lang.Class<?>, java.lang.Number, java.lang.String, java.lang.Object...) should be called which will call this method if necessary.

weirdNativeValueException

public DatabindException weirdNativeValueException(Object value,
 Class<?> instClass)

Helper method for constructing exception to indicate that input JSON token of type "native value" (see JsonToken.VALUE_EMBEDDED_OBJECT) is of incompatible type (and there is no delegating creator or such to use) and cannot be used to construct value of specified type (usually POJO). Note that most of the time this method should NOT be called; instead, handleWeirdNativeValue(tools.jackson.databind.JavaType, java.lang.Object, tools.jackson.core.JsonParser) should be called which will call this method

instantiationException

public DatabindException instantiationException(Class<?> instClass,
 Throwable cause)

Helper method for constructing instantiation exception for specified type, to indicate problem with physically constructing instance of specified class (missing constructor, exception from constructor)

Note that most of the time this method should NOT be called directly; instead, handleInstantiationProblem(java.lang.Class<?>, java.lang.Object, java.lang.Throwable) should be called which will call this method if necessary.

instantiationException

public DatabindException instantiationException(Class<?> instClass,
 String msg0)

Helper method for constructing instantiation exception for specified type, to indicate that instantiation failed due to missing instantiator (creator; constructor or factory method).

Note that most of the time this method should NOT be called; instead, handleMissingInstantiator(java.lang.Class<?>, tools.jackson.databind.deser.ValueInstantiator, tools.jackson.core.JsonParser, java.lang.String, java.lang.Object...) should be called which will call this method if necessary.

invalidTypeIdException

public DatabindException invalidTypeIdException(JavaType baseType,
 String typeId,
 String extraDesc)

Description copied from class: DatabindContext

Helper method for constructing exception to indicate that given type id could not be resolved to a valid subtype of specified base type. Most commonly called during polymorphic deserialization.

Note that most of the time this method should NOT be called directly: instead, method handleUnknownTypeId() should be called which will call this method if necessary.

Specified by:

invalidTypeIdException in class DatabindContext

missingTypeIdException

public DatabindException missingTypeIdException(JavaType baseType,
 String extraDesc)

missingInjectableValueException

public DatabindException missingInjectableValueException(String msg,
 Object valueId,
 BeanProperty forProperty,
 Object beanInstance)

_getDateFormat

protected DateFormat _getDateFormat()

Helper method to get a non-shared instance of DateFormat with default configuration; instance is lazily constructed, reused within same instance of context (that is, within same life-cycle of readValue() from mapper or reader). Reuse is safe since access will not occur from multiple threads (unless caller somehow manages to share context objects across threads which is not supported).

_shapeForToken

protected String _shapeForToken(JsonToken t)

Helper method for constructing description like "Object value" given JsonToken encountered.