io.honeybadger.com.fasterxml.jackson.databind.deser.ResolvableDeserializer Maven / Gradle / Ivy
package com.fasterxml.jackson.databind.deser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonMappingException;
/**
* Interface used to indicate deserializers that want to do post-processing
* after construction but before being returned to caller (and possibly cached)
* and used.
* This is typically used to resolve references
* to other contained types; for example, bean deserializers use this callback
* to locate deserializers for contained field types.
* Main reason for using a callback (instead of trying to resolve dependencies
* immediately) is to make it possible to cleanly handle self-references;
* otherwise it would be easy to get into infinite recursion.
*
* Note that {@link #resolve} method does NOT allow returning anything
* (specifically, a new deserializer instance): reason for this is that
* allowing this would not work with proper handling of cyclic dependencies,
* which are resolved by two-phase processing, where initially constructed
* deserializer is added as known deserializer, and only after this
* resolution is done. Resolution is the part that results in lookups for
* dependant deserializers, which may include handling references to
* deserializer itself.
*
* Note that in cases where deserializer needs both contextualization and
* resolution -- that is, implements both this interface and {@link ContextualDeserializer}
* -- resolution via this interface occurs first, and contextual
* resolution (using {@link ContextualDeserializer}) later on.
*/
public interface ResolvableDeserializer
{
/**
* Method called after deserializer instance has been constructed
* (and registered as necessary by provider objects),
* but before it has returned it to the caller.
* Called object can then resolve its dependencies to other types,
* including self-references (direct or indirect).
*
* @param ctxt Context to use for accessing configuration, resolving
* secondary deserializers
*/
public abstract void resolve(DeserializationContext ctxt)
throws JsonMappingException;
}