Jackson 2.18.2 · com.fasterxml.jackson.databind.DeserializationContext

Modifier and Type	Field and Description
protected transient ArrayBuilders	_arrayBuilders
protected transient ContextAttributes	_attributes Lazily-constructed holder for per-call attributes.
protected final DeserializerCache	_cache Object that handle details of `JsonDeserializer` caching.
protected final DeserializationConfig	_config Generic deserialization processing configuration
protected LinkedNode<JavaType>	_currentType Type of `JsonDeserializer` (or, more specifically, `ContextualDeserializer`) that is being contextualized currently.
protected transient DateFormat	_dateFormat
protected final DeserializerFactory	_factory Read-only factory instance; exposed to let owners (`ObjectMapper`, `ObjectReader`) access it.
protected final int	_featureFlags Bitmap of `DeserializationFeature`s that are enabled
protected final InjectableValues	_injectableValues Object used for resolving references to injectable values.
protected transient ObjectBuffer	_objectBuffer
protected transient JsonParser	_parser Currently active parser used for deserialization.
protected final JacksonFeatureSet<StreamReadCapability>	_readCapabilities Capabilities of the input format.
protected final Class<?>	_view Currently active view, if any.
private static final long	serialVersionUID

Access	Constructor and Description
protected	DeserializationContext(DeserializerFactory df, DeserializerCache cache)
protected	DeserializationContext(DeserializationContext src, DeserializerFactory factory)
protected	DeserializationContext(DeserializationContext src, DeserializerCache cache)
protected	DeserializationContext(DeserializationContext src, DeserializationConfig config, JsonParser p, InjectableValues injectableValues) Constructor used for creating actual per-call instances.
protected	DeserializationContext(DeserializationContext src, DeserializationConfig config) Constructor used for creating bogus per-call style instance, but without underlying parser: needed for deserializer pre-fetching
protected	DeserializationContext(DeserializationContext src) Copy-constructor for use with `copy()` by `ObjectMapper#copy()`.

Method Summary

Modifier and Type	Method and Description
protected DateFormat	_getDateFormat()
protected boolean	_isCompatible(Class<?> target, Object value)
protected String	_shapeForToken(JsonToken t) Helper method for constructing description like "Object value" given `JsonToken` encountered.
private TreeTraversingParser	_treeAsTokens(JsonNode n)
public TokenBuffer	bufferAsCopyOfValue(JsonParser p) Convenience method, equivalent to: TokenBuffer buffer = ctxt.bufferForInputBuffering(parser); buffer.copyCurrentStructure(parser); return buffer;
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)
public final TokenBuffer	bufferForInputBuffering() Convenience method that is equivalent to: ctxt.bufferForInputBuffering(ctxt.getParser());
public final boolean	canOverrideAccessModifiers() Implements abstract com.fasterxml.jackson.databind.DatabindContext.canOverrideAccessModifiers. Convenience method for accessing serialization view in use (if any); equivalent to: getConfig().canOverrideAccessModifiers();
public abstract void	checkUnresolvedObjectId() Method called to ensure that every object id encounter during processing are resolved.
public Calendar	constructCalendar(Date d) Convenience method for constructing Calendar instance set to specified time, to be modified and used by caller.
public JavaType	constructSpecializedType(JavaType baseType, Class<?> subclass) Implements abstract com.fasterxml.jackson.databind.DatabindContext.constructSpecializedType. Convenience method for constructing subtypes, retaining generic type parameter (if any).
public final JavaType	constructType(Class<?> cls) Convenience method, functionally equivalent to: getConfig().constructType(cls);
public abstract JsonDeserializer<Object>	deserializerInstance(Annotated annotated, Object deserDef)
public String	Returns: String value found; not `null` (exception should be thrown if no suitable value found) extractScalarFromObject(JsonParser Actual parser to read content from p, JsonDeserializer<?> Deserializer that needs extracted String value deser, Class<?> Immediate type of scalar to extract; usually type deserializer handles but not always (for example, deserializer for `int[]` would pass scalar type of `int`) scalarType) Method to call in case incoming shape is Object Value (and parser thereby points to `com.fasterxml.jackson.core.JsonToken#START_OBJECT` token), but a Scalar value (potentially coercible from String value) is expected.
public 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.
public CoercionAction	Returns: CoercionAction configured for specific coercion findCoercionAction(LogicalType Logical target type of coercion targetType, Class<?> Physical target type of coercion targetClass, CoercionInputShape Input shape to coerce from 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.
public CoercionAction	Returns: CoercionAction configured for specified coercion from blank string findCoercionFromBlankString(LogicalType Logical target type of coercion targetType, Class<?> Physical target type of coercion targetClass, CoercionAction Return value to use in case "blanks as empty" is not allowed 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).
public final JsonDeserializer<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.
public final Object	findInjectableValue(Object valueId, BeanProperty forProperty, Object beanInstance)
public final KeyDeserializer	findKeyDeserializer(JavaType keyType, BeanProperty prop) Convenience method, functionally same as: getDeserializerProvider().findKeyDeserializer(getConfig(), prop.getType(), prop);
public final JsonDeserializer<Object>	findNonContextualValueDeserializer(JavaType type) Variant that will try to locate deserializer for current type, but without performing any contextualization (unlike `findContextualValueDeserializer`) or checking for need to create a `TypeDeserializer` (unlike `findRootValueDeserializer(JavaType)`.
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
public final JsonDeserializer<Object>	findRootValueDeserializer(JavaType type) Method for finding a deserializer for root-level value.
public final Class<?>	getActiveView() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getActiveView. Accessor for locating currently active view, if any; returns null if no view has been set.
public final AnnotationIntrospector	getAnnotationIntrospector() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getAnnotationIntrospector. Convenience method for accessing serialization view in use (if any); equivalent to: getConfig().getAnnotationIntrospector();
public final ArrayBuilders	getArrayBuilders() Method for accessing object useful for building arrays of primitive types (such as int[]).
public Object	getAttribute(Object Key of the attribute to get key) Implements abstract com.fasterxml.jackson.databind.DatabindContext.getAttribute. Method for accessing attributes available in this context.
public final Base64Variant	getBase64Variant() Convenience method for accessing the default Base64 encoding used for decoding base64 encoded binary content.
public DeserializationConfig	getConfig() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getConfig. Accessor to currently active configuration (both per-request configs and per-mapper config).
public JavaType	Returns: Type of `ContextualDeserializer` being contextualized, if process is on-going; null if not. getContextualType() Accessor to `JavaType` of currently contextualized `ContextualDeserializer`, if any.
public final DatatypeFeatures	getDatatypeFeatures() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getDatatypeFeatures.
public final JsonFormat.Value	getDefaultPropertyFormat(Class<?> baseType) Implements abstract com.fasterxml.jackson.databind.DatabindContext.getDefaultPropertyFormat.
public final int	getDeserializationFeatures() Bulk access method for getting the bit mask of all `DeserializationFeature`s that are enabled.
public DeserializerFactory	getFactory() Method for getting current `DeserializerFactory`.
public Locale	getLocale() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getLocale. Method for accessing default Locale to use: convenience method for getConfig().getLocale();
public final JsonNodeFactory	getNodeFactory() Convenience method, functionally equivalent to: getConfig().getNodeFactory();
public final JsonParser	getParser() Method for accessing the currently active parser.
public TimeZone	getTimeZone() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getTimeZone. Method for accessing default TimeZone to use: convenience method for getConfig().getTimeZone();
public final TypeFactory	getTypeFactory() Implements abstract com.fasterxml.jackson.databind.DatabindContext.getTypeFactory.
public void	handleBadMerge(JsonDeserializer<?> deser) Method that deserializer may call if it is called to do an update ("merge") but deserializer operates on a non-mergeable type.
public Object	Returns: Object that should be constructed, if any; has to be of type `instClass` handleInstantiationProblem(Class<?> Type that was to be instantiated instClass, Object (optional) Argument that was passed to constructor or equivalent instantiator; often a `java.lang.String`. argument, Throwable Exception that caused failure 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).
public Object	Returns: Object that should be constructed, if any; has to be of type `instClass` handleMissingInstantiator(Class<?> Type that was to be instantiated instClass, ValueInstantiator (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) valueInst, JsonParser Parser that points to the JSON value to decode 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).
public JavaType	handleMissingTypeId(JavaType baseType, TypeIdResolver idResolver, String extraDesc)
public JsonDeserializer<?>	handlePrimaryContextualization(JsonDeserializer<?> deser, BeanProperty Property for which the given primary deserializer is used; never null. prop, JavaType type) Method called for primary property deserializers (ones directly created to deserialize values of a POJO property), to handle details of resolving `ContextualDeserializer` with given property context.
public JsonDeserializer<?>	handleSecondaryContextualization(JsonDeserializer<?> deser, BeanProperty Property for which deserializer is used, if any; null when deserializing root values 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 `ContextualDeserializer` with given property context.
public Object	Returns: Object that should be constructed, if any; has to be of type `instClass` handleUnexpectedToken(Class<?> Type that was to be instantiated instClass, JsonParser Parser that points to the JSON value to decode 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).
public Object	Returns: Object that should be constructed, if any; has to be of type `instClass` handleUnexpectedToken(Class<?> Type that was to be instantiated instClass, JsonToken Token encountered that does match expected t, JsonParser Parser that points to the JSON value to decode 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).
public Object	Returns: Object that should be constructed, if any; has to be of type `instClass` handleUnexpectedToken(JavaType Type that was to be instantiated targetType, JsonParser Parser that points to the JSON value to decode 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).
public Object	Returns: Object that should be constructed, if any; has to be of type `instClass` handleUnexpectedToken(JavaType Type that was to be instantiated targetType, JsonToken Token encountered that does not match expected t, JsonParser Parser that points to the JSON value to decode 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).
public boolean	Returns: True if there was a configured problem handler that was able to handle the problem handleUnknownProperty(JsonParser p, JsonDeserializer<?> 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 `DeserializationProblemHandler`s and let it handle the problem.
public JavaType	Returns: `JavaType` that id resolves to handleUnknownTypeId(JavaType Base type from which resolution starts baseType, String Type id that could not be converted id, TypeIdResolver idResolver, String Additional problem description to add to default exception message, if resolution fails. 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.
public Object	Returns: Key value to use handleWeirdKey(Class<?> Expected type for key keyClass, String String value from which to deserialize key keyValue, String Error message template caller wants to use if exception is to be thrown msg, Object... Optional arguments to use for message, if any msgArgs) Method that deserializers should call if they encounter a String value that cannot be converted to expected key of a `java.util.Map` valued property.
public Object	handleWeirdNativeValue(JavaType targetType, Object badValue, JsonParser p)
public Object	Returns: Property value to use handleWeirdNumberValue(Class<?> Type of property into which incoming number should be converted targetClass, Number Number value from which to deserialize property value value, String Error message template caller wants to use if exception is to be thrown msg, Object... Optional arguments to use for message, if any 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).
public Object	Returns: Property value to use handleWeirdStringValue(Class<?> Type of property into which incoming number should be converted targetClass, String String value from which to deserialize property value value, String Error message template caller wants to use if exception is to be thrown msg, Object... Optional arguments to use for message, if any 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).
public final boolean	hasDeserializationFeatures(int featureMask) Bulk access method for checking that all features specified by mask are enabled.
public final boolean	hasSomeOfFeatures(int featureMask) Bulk access method for checking that at least one of features specified by mask is enabled.
public boolean	hasValueDeserializerFor(JavaType Type to check type, AtomicReference<Throwable> (optional) Reference set to root cause if no deserializer could be found due to exception (to find the reason for failure) cause) Method for checking whether we could find a deserializer for given type.
public JsonMappingException	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` should be called which will call this method if necessary.
public JsonMappingException	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).
public JsonMappingException	invalidTypeIdException(JavaType baseType, String typeId, String extraDesc) Implements abstract com.fasterxml.jackson.databind.DatabindContext.invalidTypeIdException. Helper method for constructing exception to indicate that given type id could not be resolved to a valid subtype of specified base type.
public final boolean	isEnabled(MapperFeature feature) Implements abstract com.fasterxml.jackson.databind.DatabindContext.isEnabled. Convenience method for checking whether specified Mapper feature is enabled or not.
public final boolean	isEnabled(DatatypeFeature feature) Implements abstract com.fasterxml.jackson.databind.DatabindContext.isEnabled. Method for checking whether specified datatype feature is enabled or not.
public final boolean	isEnabled(DeserializationFeature feat) Convenience method for checking whether specified on/off feature is enabled
public final boolean	Returns: True if input format has specified capability; false if not isEnabled(StreamReadCapability cap) Accessor for checking whether input format has specified capability or not.
public abstract KeyDeserializer	keyDeserializerInstance(Annotated annotated, Object deserDef)
public final ObjectBuffer	leaseObjectBuffer() Method that can be used to get access to a reusable ObjectBuffer, useful for efficiently constructing Object arrays and Lists.
public JsonMappingException	missingTypeIdException(JavaType baseType, String extraDesc)
public Date	parseDate(String dateStr) Convenience method for parsing a Date from given String, using currently configured date format (accessed using `DeserializationConfig#getDateFormat()`).
public <T> T	Returns: Value of type `type` that was read readPropertyValue(JsonParser Parser that points to the first token of the value to read p, BeanProperty Logical property of a POJO being type 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.
public <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.
public JsonNode	Returns: Value read as `JsonNode` readTree(JsonParser Parser that points to the first token of the value to read p) Convenience method for reading the value that passed `JsonParser` points to as a `JsonNode`.
public <T> T	Returns: Either `null` (if `n` was `null` or a value of type `type` that was read from non-`null` `n` argument readTreeAsValue(JsonNode Tree value to convert, if not `null`: if `null`, will simply return `null` n, Class<T> Type to deserialize contents of `n` into (if `n` not `null`) targetType) Helper method similar to `ObjectReader#treeToValue(TreeNode, Class)` which will read contents of given tree (`JsonNode`) and bind them into specified target type.
public <T> T	Returns: Value of type `type` that was read readTreeAsValue(JsonNode Tree value to convert n, JavaType Type to deserialize contents of `n` into targetType) 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.
public <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).
public <T> T	readValue(JsonParser p, JavaType type)
public <T> T	reportBadCoercion(JsonDeserializer<?> 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.
public <T> T	reportBadDefinition(JavaType type, String msg) Implements abstract com.fasterxml.jackson.databind.DatabindContext.reportBadDefinition. 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 `com.fasterxml.jackson.databind.exc.InvalidDefinitionException`.
public <T> T	reportBadPropertyDefinition(BeanDescription bean, 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.
public <T> T	reportBadTypeDefinition(BeanDescription bean, String msg, Object... msgArgs) Implements abstract com.fasterxml.jackson.databind.DatabindContext.reportBadTypeDefinition. Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific Java type, unrelated to actual JSON content to map.
public <T> T	reportInputMismatch(JsonDeserializer<?> src, String msg, Object... msgArgs) Helper method used to indicate a problem with input in cases where more specific `reportXxx()` method was not available.
public <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.
public <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.
public <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.
public <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.
public <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.
public <T> T	reportTrailingTokens(Class<?> targetType, JsonParser p, JsonToken trailingToken)
public <T> T	reportUnresolvedObjectId(ObjectIdReader oidReader, Object bean)
public void	reportWrongTokenException(JsonDeserializer<?> 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.
public 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.
public 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.
public final void	returnObjectBuffer(ObjectBuffer Returned object buffer buf) Method to call to return object buffer previously leased with `leaseObjectBuffer`.
public DeserializationContext	setAttribute(Object Key of the attribute to set key, Object Value to set attribute to value) Implements abstract com.fasterxml.jackson.databind.DatabindContext.setAttribute. Method for setting per-call value of given attribute.
public JsonMappingException	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.
public JsonMappingException	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 can not be used to construct value of specified type (usually POJO).
public JsonMappingException	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.
public JsonMappingException	weirdStringException(String String value from input being deserialized value, Class<?> Type that String should be deserialized into instClass, String Message that describes specific problem msgBase) Helper method for constructing exception to indicate that input JSON String was not suitable for deserializing into given target type.
public JsonMappingException	wrongTokenException(JsonParser p, JavaType targetType, JsonToken expToken, String extra) Helper method for constructing `JsonMappingException` 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.
public JsonMappingException	wrongTokenException(JsonParser p, Class<?> targetType, JsonToken expToken, String extra)

Inherited from com.fasterxml.jackson.databind.DatabindContext:: _colonConcat _desc _format _quotedString _throwNotASubtype _throwSubtypeClassNotAllowed _throwSubtypeNameNotAllowed _truncate constructType converterInstance objectIdGeneratorInstance objectIdResolverInstance reportBadDefinition resolveAndValidateSubType resolveSubType

public abstract Class DeserializationContext

Field Summary

Constructor Summary

Method Summary