Module tools.jackson.databind
Package tools.jackson.databind.jsontype.impl

Class TypeIdResolverBase

java.lang.Object
tools.jackson.databind.jsontype.impl.TypeIdResolverBase
All Implemented Interfaces:
Serializable, TypeIdResolver
Direct Known Subclasses:
ClassNameIdResolver, SimpleNameIdResolver, TypeNameIdResolver
public abstract class TypeIdResolverBase extends Object implements TypeIdResolver, Serializable
Partial base implementation of TypeIdResolver: all custom implementations are strongly recommended to extend this class, instead of directly implementing TypeIdResolver. Note that ALL sub-class need to re-implement typeFromId(DatabindContext, String) method; otherwise implementation will not work.

Note that instances created to be constructed from annotations (JsonTypeIdResolver) are always created using no-arguments constructor; protected constructor is only used sub-classes.

See Also:

  • Field Details

    • _baseType

      protected final JavaType _baseType
      Common base type for all polymorphic instances handled.

  • Constructor Details

    • TypeIdResolverBase

      protected TypeIdResolverBase()

    • TypeIdResolverBase

      protected TypeIdResolverBase(JavaType baseType)

  • Method Details

    • init

      public void init(JavaType bt)
      Description copied from interface: TypeIdResolver
      Method that will be called once before any type resolution calls; used to initialize instance with configuration. This is necessary since instances may be created via reflection, without ability to call specific constructor to pass in configuration settings.
      Specified by:
      init in interface TypeIdResolver
      Parameters:
      bt - Base type for which this id resolver instance is used

    • idFromBaseType

      public String idFromBaseType(DatabindContext ctxt)
      Description copied from interface: TypeIdResolver
      Method that can be called to figure out type id to use for instances of base type (declared type of property). This is usually only used for fallback handling, for cases where real type information is not available for some reason.
      Specified by:
      idFromBaseType in interface TypeIdResolver

    • typeFromId

      public JavaType typeFromId(DatabindContext context, String id) throws JacksonException
      Description copied from interface: TypeIdResolver
      Method called to resolve type from given type identifier.
      Specified by:
      typeFromId in interface TypeIdResolver
      Throws:
      JacksonException

    • getDescForKnownTypeIds

      public String getDescForKnownTypeIds()
      Helper method used to get a simple description of all known type ids, for use in error messages.
      Specified by:
      getDescForKnownTypeIds in interface TypeIdResolver

    • _resolveToParentAsNecessary

      protected Class<?> _resolveToParentAsNecessary(Class<?> cls)
      Helper method for ensuring we properly resolve cases where we don't want to use given instance class due to it being a specific inner class but rather enclosing (or parent) class. Specific case we know of currently are "enum subtypes", cases where simple Enum constant has overrides and uses generated sub-class if parent Enum type. In this case we need to ensure that we use the main/parent Enum type, not sub-class.
      Parameters:
      cls - Class to check and possibly resolve
      Returns:
      Resolved class to use
      Since:
      2.18.2