MapperConfigBase (The Adobe AEM Quickstart and Web Application.)

java.lang.Object
- com.fasterxml.jackson.databind.cfg.MapperConfig<T>
- - com.fasterxml.jackson.databind.cfg.MapperConfigBase<CFG,T>

All Implemented Interfaces:

ClassIntrospector.MixInResolver, java.io.Serializable

Direct Known Subclasses:

DeserializationConfig, SerializationConfig
```
public abstract class MapperConfigBase<CFG extends ConfigFeature,T extends MapperConfigBase<CFG,T>>
extends MapperConfig<T>
implements java.io.Serializable
```
See Also:

Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ClassIntrospector.MixInResolver`	`copy()` Method called to create a new, non-shared copy, to be used by different `ObjectMapper` instance, and one that should not be connected to this instance, if resolver has mutable state.
`ConfigOverride`	`findConfigOverride(java.lang.Class<?> type)` Accessor for finding `ConfigOverride` to use for properties of given type, if any exist; or return `null` if not.
`java.lang.Class<?>`	`findMixInClassFor(java.lang.Class<?> cls)` Method that will check if there are "mix-in" classes (with mix-in annotations) for given class
`PropertyName`	`findRootName(java.lang.Class<?> rawRootType)`
`PropertyName`	`findRootName(JavaType rootType)`
`java.lang.Class<?>`	`getActiveView()` Accessor for finding currently active view, if any (null if none)
`ContextAttributes`	`getAttributes()` Method for accessing per-instance shared (baseline/default) attribute values; these are used as the basis for per-call attributes.
`ConfigOverride`	`getConfigOverride(java.lang.Class<?> type)` Accessor for finding `ConfigOverride` to use for properties of given type, if any exist; or if none, return an immutable "empty" instance with no overrides.
`JsonInclude.Value`	`getDefaultInclusion(java.lang.Class<?> baseType, java.lang.Class<?> propertyType)` Accessor for default property inclusion to use for serialization, considering possible per-type override for given base type and possible per-type override for given property type. NOTE: if no override found, defaults to value returned by `MapperConfig.getDefaultPropertyInclusion()`.
`java.lang.Boolean`	`getDefaultMergeable()` Accessor for the baseline merge info used as the global baseline, not considering possible per-type overrides.
`java.lang.Boolean`	`getDefaultMergeable(java.lang.Class<?> baseType)` Accessor for the baseline merge info used for given type, including global defaults if no type-specific overrides defined.
`JsonFormat.Value`	`getDefaultPropertyFormat(java.lang.Class<?> type)` Accessor for default format settings to use for serialization (and, to a degree deserialization), considering baseline settings and per-type defaults for given base type (if any).
`JsonIgnoreProperties.Value`	`getDefaultPropertyIgnorals(java.lang.Class<?> type)` Accessor for default property ignorals to use, if any, for given base type, based on config overrides settings (see `MapperConfig.findConfigOverride(Class)`).
`JsonIgnoreProperties.Value`	`getDefaultPropertyIgnorals(java.lang.Class<?> baseType, AnnotatedClass actualClass)` Helper method that may be called to see if there are property ignoral definitions from annotations (via `AnnotatedClass`) or through "config overrides".
`JsonInclude.Value`	`getDefaultPropertyInclusion()` Accessor for default property inclusion to use for serialization, used unless overridden by per-type or per-property overrides.
`JsonInclude.Value`	`getDefaultPropertyInclusion(java.lang.Class<?> baseType)` Accessor for default property inclusion to use for serialization, considering possible per-type override for given base type. NOTE: if no override found, defaults to value returned by `MapperConfig.getDefaultPropertyInclusion()`.
`JsonSetter.Value`	`getDefaultSetterInfo()` Accessor for the baseline setter info used as the global baseline, not considering possible per-type overrides.
`VisibilityChecker<?>`	`getDefaultVisibilityChecker()` Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers).
`VisibilityChecker<?>`	`getDefaultVisibilityChecker(java.lang.Class<?> baseType, AnnotatedClass actualClass)` Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers).
`PropertyName`	`getFullRootName()`
`java.lang.String`	`getRootName()` Deprecated. Since 2.6 use `getFullRootName()` instead.
`SubtypeResolver`	`getSubtypeResolver()` Accessor for object used for finding out all reachable subtypes for supertypes; needed when a logical type name is used instead of class name (or custom scheme).
`int`	`mixInCount()` Test-only method -- does not reflect possibly open-ended set that external mix-in resolver might provide.
`T`	`with(AnnotationIntrospector ai)` Method for constructing and returning a new instance with different `AnnotationIntrospector` to use (replacing old one).
`T`	`with(Base64Variant base64)` Method for constructing and returning a new instance with different default `Base64Variant` to use with base64-encoded binary values.
`T`	`with(ClassIntrospector ci)` Method for constructing and returning a new instance with different `ClassIntrospector` to use.
`abstract T`	`with(ContextAttributes attrs)` Method for constructing an instance that has specified contextual attributes.
`T`	`with(java.text.DateFormat df)` Method for constructing and returning a new instance with different `DateFormat` to use.
`T`	`with(HandlerInstantiator hi)` Method for constructing and returning a new instance with different `HandlerInstantiator` to use.
`T`	`with(java.util.Locale l)` Method for constructing and returning a new instance with different default `Locale` to use for formatting.
`T`	`with(MapperFeature... features)` Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
`T`	`with(MapperFeature feature, boolean state)`
`T`	`with(PropertyNamingStrategy pns)` Method for constructing and returning a new instance with different `PropertyNamingStrategy` to use.
`abstract T`	`with(SubtypeResolver str)` Method for constructing and returning a new instance with different `SubtypeResolver` to use.
`T`	`with(java.util.TimeZone tz)` Method for constructing and returning a new instance with different default `TimeZone` to use for formatting of date values.
`T`	`with(TypeFactory tf)` Method for constructing and returning a new instance with different `TypeFactory` to use.
`T`	`with(TypeResolverBuilder<?> trb)` Method for constructing and returning a new instance with different `TypeResolverBuilder` to use.
`T`	`withAppendedAnnotationIntrospector(AnnotationIntrospector ai)` Method for constructing and returning a new instance with additional `AnnotationIntrospector` appended (as the lowest priority one)
`T`	`withAttribute(java.lang.Object key, java.lang.Object value)` Method for constructing an instance that has specified value for attribute for given key.
`T`	`withAttributes(java.util.Map<?,?> attributes)` Method for constructing an instance that has only specified attributes, removing any attributes that exist before the call.
`T`	`withInsertedAnnotationIntrospector(AnnotationIntrospector ai)` Method for constructing and returning a new instance with additional `AnnotationIntrospector` inserted (as the highest priority one)
`T`	`without(MapperFeature... features)` Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
`T`	`withoutAttribute(java.lang.Object key)` Method for constructing an instance that has no value for attribute for given key.
`abstract T`	`withRootName(PropertyName rootName)` Method for constructing and returning a new instance with different root name to use (none, if null).
`T`	`withRootName(java.lang.String rootName)`
`abstract T`	`withView(java.lang.Class<?> view)` Method for constructing and returning a new instance with different view to use.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - with
```
public final T with(MapperFeature... features)
```
    Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
    
    Specified by:
    
    with in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - without
```
public final T without(MapperFeature... features)
```
    Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
    
    Specified by:
    
    without in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - with
```
public final T with(MapperFeature feature,
                    boolean state)
```
    Specified by:
    
    with in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - with
```
public final T with(AnnotationIntrospector ai)
```
    Method for constructing and returning a new instance with different AnnotationIntrospector to use (replacing old one).
    NOTE: make sure to register new instance with ObjectMapper if directly calling this method.
  - withAppendedAnnotationIntrospector
```
public final T withAppendedAnnotationIntrospector(AnnotationIntrospector ai)
```
    Method for constructing and returning a new instance with additional AnnotationIntrospector appended (as the lowest priority one)
  - withInsertedAnnotationIntrospector
```
public final T withInsertedAnnotationIntrospector(AnnotationIntrospector ai)
```
    Method for constructing and returning a new instance with additional AnnotationIntrospector inserted (as the highest priority one)
  - with
```
public final T with(ClassIntrospector ci)
```
    Method for constructing and returning a new instance with different ClassIntrospector to use.
    NOTE: make sure to register new instance with ObjectMapper if directly calling this method.
  - with
```
public abstract T with(ContextAttributes attrs)
```
    Method for constructing an instance that has specified contextual attributes.
    
    Since:
    
    2.3
  - withAttributes
```
public T withAttributes(java.util.Map<?,?> attributes)
```
    Method for constructing an instance that has only specified attributes, removing any attributes that exist before the call.
    
    Since:
    
    2.3
  - withAttribute
```
public T withAttribute(java.lang.Object key,
                       java.lang.Object value)
```
    Method for constructing an instance that has specified value for attribute for given key.
    
    Since:
    
    2.3
  - withoutAttribute
```
public T withoutAttribute(java.lang.Object key)
```
    Method for constructing an instance that has no value for attribute for given key.
    
    Since:
    
    2.3
  - with
```
public final T with(TypeFactory tf)
```
    Method for constructing and returning a new instance with different TypeFactory to use.
  - with
```
public final T with(TypeResolverBuilder<?> trb)
```
    Method for constructing and returning a new instance with different TypeResolverBuilder to use.
  - with
```
public final T with(PropertyNamingStrategy pns)
```
    Method for constructing and returning a new instance with different PropertyNamingStrategy to use.
    NOTE: make sure to register new instance with ObjectMapper if directly calling this method.
  - with
```
public final T with(HandlerInstantiator hi)
```
    Method for constructing and returning a new instance with different HandlerInstantiator to use.
    NOTE: make sure to register new instance with ObjectMapper if directly calling this method.
  - with
```
public final T with(Base64Variant base64)
```
    Method for constructing and returning a new instance with different default Base64Variant to use with base64-encoded binary values.
  - with
```
public T with(java.text.DateFormat df)
```
    Method for constructing and returning a new instance with different DateFormat to use.
    NOTE: non-final since SerializationConfig needs to override this
  - with
```
public final T with(java.util.Locale l)
```
    Method for constructing and returning a new instance with different default Locale to use for formatting.
  - with
```
public final T with(java.util.TimeZone tz)
```
    Method for constructing and returning a new instance with different default TimeZone to use for formatting of date values.
  - withRootName
```
public abstract T withRootName(PropertyName rootName)
```
    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.
    
    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.
    
    Since:
    
    2.6
  - withRootName
```
public T withRootName(java.lang.String rootName)
```
  - with
```
public abstract T with(SubtypeResolver str)
```
    Method for constructing and returning a new instance with different SubtypeResolver to use.
    NOTE: make sure to register new instance with ObjectMapper if directly calling this method.
  - withView
```
public abstract T withView(java.lang.Class<?> view)
```
    Method for constructing and returning a new instance with different view to use.
  - getSubtypeResolver
```
public final SubtypeResolver getSubtypeResolver()
```
    Accessor for object used for finding out all reachable subtypes for supertypes; needed when a logical type name is used instead of class name (or custom scheme).
    
    Specified by:
    
    getSubtypeResolver in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getRootName
```
@Deprecated
public final java.lang.String getRootName()
```
    Deprecated. Since 2.6 use getFullRootName() instead.
  - getFullRootName
```
public final PropertyName getFullRootName()
```
    Since:
    
    2.6
  - getActiveView
```
public final java.lang.Class<?> getActiveView()
```
    Description copied from class: MapperConfig
    
    Accessor for finding currently active view, if any (null if none)
    
    Specified by:
    
    getActiveView in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getAttributes
```
public final ContextAttributes getAttributes()
```
    Description copied from class: MapperConfig
    
    Method for accessing per-instance shared (baseline/default) attribute values; these are used as the basis for per-call attributes.
    
    Specified by:
    
    getAttributes in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getConfigOverride
```
public final ConfigOverride getConfigOverride(java.lang.Class<?> type)
```
    Description copied from class: MapperConfig
    
    Accessor for finding ConfigOverride to use for properties of given type, if any exist; or if none, return an immutable "empty" instance with no overrides.
    Note that only directly associated override is found; no type hierarchy traversal is performed.
    
    Specified by:
    
    getConfigOverride in class MapperConfig<T extends MapperConfigBase<CFG,T>>
    
    Returns:
    
    Override object to use for the type, never null (but may be empty)
  - findConfigOverride
```
public final ConfigOverride findConfigOverride(java.lang.Class<?> type)
```
    Description copied from class: MapperConfig
    
    Accessor for finding ConfigOverride to use for properties of given type, if any exist; or return `null` if not.
    Note that only directly associated override is found; no type hierarchy traversal is performed.
    
    Specified by:
    
    findConfigOverride in class MapperConfig<T extends MapperConfigBase<CFG,T>>
    
    Returns:
    
    Override object to use for the type, if defined; null if none.
  - getDefaultPropertyInclusion
```
public final JsonInclude.Value getDefaultPropertyInclusion()
```
    Description copied from class: MapperConfig
    
    Accessor for default property inclusion to use for serialization, used unless overridden by per-type or per-property overrides.
    
    Specified by:
    
    getDefaultPropertyInclusion in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultPropertyInclusion
```
public final JsonInclude.Value getDefaultPropertyInclusion(java.lang.Class<?> baseType)
```
    Description copied from class: MapperConfig
    
    Accessor for default property inclusion to use for serialization, considering possible per-type override for given base type.
    NOTE: if no override found, defaults to value returned by MapperConfig.getDefaultPropertyInclusion().
    
    Specified by:
    
    getDefaultPropertyInclusion in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultInclusion
```
public final JsonInclude.Value getDefaultInclusion(java.lang.Class<?> baseType,
                                                   java.lang.Class<?> propertyType)
```
    Description copied from class: MapperConfig
    
    Accessor for default property inclusion to use for serialization, considering possible per-type override for given base type and possible per-type override for given property type.
    NOTE: if no override found, defaults to value returned by MapperConfig.getDefaultPropertyInclusion().
    
    Specified by:
    
    getDefaultInclusion in class MapperConfig<T extends MapperConfigBase<CFG,T>>
    
    Parameters:
    
    baseType - Type of the instance containing the targeted property.
    
    propertyType - Type of the property to look up inclusion setting for.
  - getDefaultPropertyFormat
```
public final JsonFormat.Value getDefaultPropertyFormat(java.lang.Class<?> type)
```
    Description copied from class: MapperConfig
    
    Accessor for default format settings to use for serialization (and, to a degree deserialization), considering baseline settings and per-type defaults for given base type (if any).
    
    Specified by:
    
    getDefaultPropertyFormat in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultPropertyIgnorals
```
public final JsonIgnoreProperties.Value getDefaultPropertyIgnorals(java.lang.Class<?> type)
```
    Description copied from class: MapperConfig
    
    Accessor for default property ignorals to use, if any, for given base type, based on config overrides settings (see MapperConfig.findConfigOverride(Class)).
    
    Specified by:
    
    getDefaultPropertyIgnorals in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultPropertyIgnorals
```
public final JsonIgnoreProperties.Value getDefaultPropertyIgnorals(java.lang.Class<?> baseType,
                                                                   AnnotatedClass actualClass)
```
    Description copied from class: MapperConfig
    
    Helper method that may be called to see if there are property ignoral definitions from annotations (via AnnotatedClass) or through "config overrides". If both exist, config overrides have precedence over class annotations.
    
    Specified by:
    
    getDefaultPropertyIgnorals in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultVisibilityChecker
```
public final VisibilityChecker<?> getDefaultVisibilityChecker()
```
    Description copied from class: MapperConfig
    
    Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers). Can be changed to allow different minimum visibility levels for auto-detection. Note that this is the global handler; individual types (classes) can further override active checker used (using JsonAutoDetect annotation)
    
    Specified by:
    
    getDefaultVisibilityChecker in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultVisibilityChecker
```
public final VisibilityChecker<?> getDefaultVisibilityChecker(java.lang.Class<?> baseType,
                                                              AnnotatedClass actualClass)
```
    Description copied from class: MapperConfig
    
    Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers). This is based on global defaults (as would be returned by MapperConfig.getDefaultVisibilityChecker(), but then modified by possible class annotation (see JsonAutoDetect) and/or per-type config override (see ConfigOverride.getVisibility()).
    
    Specified by:
    
    getDefaultVisibilityChecker in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - getDefaultSetterInfo
```
public final JsonSetter.Value getDefaultSetterInfo()
```
    Description copied from class: MapperConfig
    
    Accessor for the baseline setter info used as the global baseline, not considering possible per-type overrides.
    
    Specified by:
    
    getDefaultSetterInfo in class MapperConfig<T extends MapperConfigBase<CFG,T>>
    
    Returns:
    
    Global base settings; never null
  - getDefaultMergeable
```
public java.lang.Boolean getDefaultMergeable()
```
    Description copied from class: MapperConfig
    
    Accessor for the baseline merge info used as the global baseline, not considering possible per-type overrides.
    
    Specified by:
    
    getDefaultMergeable in class MapperConfig<T extends MapperConfigBase<CFG,T>>
    
    Returns:
    
    Global base settings, if any; `null` if none.
  - getDefaultMergeable
```
public java.lang.Boolean getDefaultMergeable(java.lang.Class<?> baseType)
```
    Description copied from class: MapperConfig
    
    Accessor for the baseline merge info used for given type, including global defaults if no type-specific overrides defined.
    
    Specified by:
    
    getDefaultMergeable in class MapperConfig<T extends MapperConfigBase<CFG,T>>
    
    Returns:
    
    Type-specific settings (if any); global defaults (same as MapperConfig.getDefaultMergeable()) otherwise, if any defined; or `null` if neither defined
  - findRootName
```
public PropertyName findRootName(JavaType rootType)
```
    Specified by:
    
    findRootName in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - findRootName
```
public PropertyName findRootName(java.lang.Class<?> rawRootType)
```
    Specified by:
    
    findRootName in class MapperConfig<T extends MapperConfigBase<CFG,T>>
  - findMixInClassFor
```
public final java.lang.Class<?> findMixInClassFor(java.lang.Class<?> cls)
```
    Method that will check if there are "mix-in" classes (with mix-in annotations) for given class
    
    Specified by:
    
    findMixInClassFor in interface ClassIntrospector.MixInResolver
  - copy
```
public ClassIntrospector.MixInResolver copy()
```
    Description copied from interface: ClassIntrospector.MixInResolver
    
    Method called to create a new, non-shared copy, to be used by different ObjectMapper instance, and one that should not be connected to this instance, if resolver has mutable state. If resolver is immutable may simply return `this`.
    
    Specified by:
    
    copy in interface ClassIntrospector.MixInResolver
  - mixInCount
```
public final int mixInCount()
```
    Test-only method -- does not reflect possibly open-ended set that external mix-in resolver might provide.

Class MapperConfigBase<CFG extends ConfigFeature,T extends MapperConfigBase<CFG,T>>

Method Summary

Methods inherited from class com.fasterxml.jackson.databind.cfg.MapperConfig

Methods inherited from class java.lang.Object

Method Detail

with

without

with

with

withAppendedAnnotationIntrospector

withInsertedAnnotationIntrospector

with

with

withAttributes

withAttribute

withoutAttribute

with

with

with

with

with

with

with

with

withRootName

withRootName

with

withView

getSubtypeResolver

getRootName

getFullRootName

getActiveView

getAttributes

getConfigOverride

findConfigOverride

getDefaultPropertyInclusion

getDefaultPropertyInclusion

getDefaultInclusion

getDefaultPropertyFormat

getDefaultPropertyIgnorals

getDefaultPropertyIgnorals

getDefaultVisibilityChecker

getDefaultVisibilityChecker

getDefaultSetterInfo

getDefaultMergeable

getDefaultMergeable

findRootName

findRootName

findMixInClassFor

copy

mixInCount