Module tools.jackson.databind
Package tools.jackson.databind

Class DeserializationConfig

java.lang.Object
tools.jackson.databind.cfg.MapperConfig<T>
tools.jackson.databind.cfg.MapperConfigBase<DeserializationFeature,DeserializationConfig>
tools.jackson.databind.DeserializationConfig
All Implemented Interfaces:
Serializable, Snapshottable<MixInResolver>, MixInResolver
public final class DeserializationConfig extends MapperConfigBase<DeserializationFeature,DeserializationConfig> implements Serializable
Object that contains baseline configuration for deserialization process. An instance is owned by ObjectMapper, which passes an immutable instance to be used for deserialization process.

Note that instances are considered immutable and as such no copies should need to be created for sharing; all copying is done with "fluent factory" methods.

See Also:

  • Field Details

    • _deserFeatures

      protected final int _deserFeatures
      Set of DeserializationFeatures enabled.

    • _streamReadFeatures

      protected final int _streamReadFeatures
      States of StreamReadFeatures to enable/disable.

    • _formatReadFeatures

      protected final int _formatReadFeatures
      States of FormatFeatures to enable/disable.

    • _problemHandlers

      protected final LinkedNode<DeserializationProblemHandler> _problemHandlers
      Linked list that contains all registered problem handlers. Implementation as front-added linked list allows for sharing of the list (tail) without copying the list.

    • _abstractTypeResolvers

      protected final AbstractTypeResolver[] _abstractTypeResolvers
      List of objects that may be able to resolve abstract types to concrete types. Used by functionality like "mr Bean" to materialize types as needed, although may be used for other kinds of defaulting as well.

    • _coercionConfigs

      protected final CoercionConfigs _coercionConfigs
      Configured coercion rules for coercions from secondary input shapes.

  • Constructor Details

  • Method Details

    • getBaseSettings

      protected BaseSettings getBaseSettings()

    • _withBase

      protected final DeserializationConfig _withBase(BaseSettings newBase)
      Specified by:
      _withBase in class MapperConfigBase<DeserializationFeature,DeserializationConfig>

    • _with

      protected final DeserializationConfig _with(DatatypeFeatures dtFeatures)
      Specified by:
      _with in class MapperConfigBase<DeserializationFeature,DeserializationConfig>

    • withRootName

      public DeserializationConfig withRootName(PropertyName rootName)
      Description copied from class: MapperConfigBase
      Method for constructing and returning a new instance with different root name to use (none, if null).

      Note that when a root name is set to a non-Empty String, this will automatically force use of root element wrapping with given name. If empty String passed, will disable root name wrapping; and if null used, will instead use SerializationFeature to determine if to use wrapping, and annotation (or default name) for actual root name to use.

      Specified by:
      withRootName in class MapperConfigBase<DeserializationFeature,DeserializationConfig>
      Parameters:
      rootName - to use: if null, means "use default" (clear setting); if empty String ("") means that no root name wrapping is used; otherwise defines root name to use.

    • withView

      public DeserializationConfig withView(Class<?> view)
      Description copied from class: MapperConfigBase
      Method for constructing and returning a new instance with different view to use.
      Specified by:
      withView in class MapperConfigBase<DeserializationFeature,DeserializationConfig>

    • with

      public DeserializationConfig with(ContextAttributes attrs)
      Description copied from class: MapperConfigBase
      Method for constructing an instance that has specified contextual attributes.
      Specified by:
      with in class MapperConfigBase<DeserializationFeature,DeserializationConfig>

    • with

      public DeserializationConfig with(DeserializationFeature feature)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • with

      public DeserializationConfig with(DeserializationFeature first, DeserializationFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • withFeatures

      public DeserializationConfig withFeatures(DeserializationFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • without

      public DeserializationConfig without(DeserializationFeature feature)
      Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

    • without

      public DeserializationConfig without(DeserializationFeature first, DeserializationFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

    • withoutFeatures

      public DeserializationConfig withoutFeatures(DeserializationFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

    • with

      public DeserializationConfig with(StreamReadFeature feature)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • withFeatures

      public DeserializationConfig withFeatures(StreamReadFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • without

      public DeserializationConfig without(StreamReadFeature feature)
      Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

    • withoutFeatures

      public DeserializationConfig withoutFeatures(StreamReadFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

    • with

      public DeserializationConfig with(FormatFeature feature)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • withFeatures

      public DeserializationConfig withFeatures(FormatFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

    • without

      public DeserializationConfig without(FormatFeature feature)
      Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

    • withoutFeatures

      public DeserializationConfig withoutFeatures(FormatFeature... features)
      Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

    • withHandler

      public DeserializationConfig withHandler(DeserializationProblemHandler h)
      Method that can be used to add a handler that can (try to) resolve non-fatal deserialization problems.

    • withNoProblemHandlers

      public DeserializationConfig withNoProblemHandlers()
      Method for removing all configured problem handlers; usually done to replace existing handler(s) with different one(s)

    • getStreamReadFeatures

      public int getStreamReadFeatures()
      Since:
      3.0

    • getFormatReadFeatures

      public int getFormatReadFeatures()
      Since:
      3.0

    • useRootWrapping

      public boolean useRootWrapping()
      Description copied from class: MapperConfig
      Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not.
      Specified by:
      useRootWrapping in class MapperConfig<DeserializationConfig>

    • isEnabled

      public final boolean isEnabled(DeserializationFeature f)

    • isEnabled

      public final boolean isEnabled(StreamReadFeature f)

    • hasFormatFeature

      public final boolean hasFormatFeature(FormatFeature f)

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

    • getDeserializationFeatures

      public final int getDeserializationFeatures()
      Bulk access method for getting the bit mask of all DeserializationFeatures that are enabled.

    • requiresFullValue

      public final boolean requiresFullValue()
      Convenience method equivalent to: isEnabled(DeserializationFeature.FAIL_ON_TRAILING_TOKENS)

    • hasAbstractTypeResolvers

      public boolean hasAbstractTypeResolvers()
      Since:
      3.0

    • abstractTypeResolvers

      public Iterable<AbstractTypeResolver> abstractTypeResolvers()
      Since:
      3.0

    • mapAbstractType

      public JavaType mapAbstractType(JavaType type)
      Since:
      3.0

    • getProblemHandlers

      public LinkedNode<DeserializationProblemHandler> getProblemHandlers()
      Method for getting head of the problem handler chain. May be null, if no handlers have been added.

    • 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
      Since:
      2.12

    • 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
      Since:
      2.12