Class MapperConfigBase<CFG extends ConfigFeature,T extends MapperConfigBase<CFG,T>>
- All Implemented Interfaces:
ClassIntrospector.MixInResolver
,Serializable
- Direct Known Subclasses:
DeserializationConfig
,SerializationConfig
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final ContextAttributes
Contextual attributes accessible (get and set) during processing, on per-call basis.protected final ConfigOverrides
Configuration overrides to apply, keyed by type of property.protected final SimpleMixInResolver
Mix-in annotation mappings to use, if any: immutable, cannot be changed once defined.protected final PropertyName
Explicitly defined root name to use, if any; if empty String, will disable root-name wrapping; if null, will use defaultsprotected final RootNameLookup
Simple cache used for finding out possible root name for root name wrapping.protected final SubtypeResolver
Registered concrete subtypes that can be used instead of (or in addition to) ones declared using annotations.protected final Class<?>
View to use for filtering out properties to serialize or deserialize.protected static final ConfigOverride
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.MapperConfig
_base, _mapperFeatures, EMPTY_FORMAT, EMPTY_INCLUDE
-
Constructor Summary
ModifierConstructorDescriptionprotected
MapperConfigBase
(BaseSettings base, SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames, ConfigOverrides configOverrides) Constructor used when creating a new instance (compared to that of creating fluent copies)protected
MapperConfigBase
(MapperConfigBase<CFG, T> src) Pass-through constructor used when no changes are needed to the base class.protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, long mapperFeatures) protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, BaseSettings base) protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, ContextAttributes attr) protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, SimpleMixInResolver mixins) protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, SubtypeResolver str) protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames, ConfigOverrides configOverrides) Copy constructor usually called to make a copy for use by ObjectMapper that is copied.protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, PropertyName rootName) protected
MapperConfigBase
(MapperConfigBase<CFG, T> src, Class<?> view) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract T
_withBase
(BaseSettings newBase) protected abstract T
_withMapperFeatures
(long mapperFeatures) copy()
Method called to create a new, non-shared copy, to be used by differentObjectMapper
instance, and one that should not be connected to this instance, if resolver has mutable state.final ConfigOverride
findConfigOverride
(Class<?> type) Accessor for findingConfigOverride
to use for properties of given type, if any exist; or return `null` if not.final Class<?>
findMixInClassFor
(Class<?> cls) Method that will check if there are "mix-in" classes (with mix-in annotations) for given classfindRootName
(JavaType rootType) findRootName
(Class<?> rawRootType) final Class<?>
Accessor for finding currently active view, if any (null if none)final ContextAttributes
Method for accessing per-instance shared (baseline/default) attribute values; these are used as the basis for per-call attributes.final ConfigOverride
getConfigOverride
(Class<?> type) Accessor for findingConfigOverride
to use for properties of given type, if any exist; or if none, return an immutable "empty" instance with no overrides.final JsonInclude.Value
getDefaultInclusion
(Class<?> baseType, 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 byMapperConfig.getDefaultPropertyInclusion()
.Accessor for the baseline merge info used as the global baseline, not considering possible per-type overrides.getDefaultMergeable
(Class<?> baseType) Accessor for the baseline merge info used for given type, including global defaults if no type-specific overrides defined.final JsonFormat.Value
getDefaultPropertyFormat
(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).getDefaultPropertyIgnorals
(Class<?> type) Accessor for default property ignorals to use, if any, for given base type, based on config overrides settings (seeMapperConfig.findConfigOverride(Class)
).getDefaultPropertyIgnorals
(Class<?> baseType, AnnotatedClass actualClass) Helper method that may be called to see if there are property ignoral definitions from annotations (viaAnnotatedClass
) or through "config overrides".final JsonInclude.Value
Accessor for default property inclusion to use for serialization, used unless overridden by per-type or per-property overrides.final JsonInclude.Value
getDefaultPropertyInclusion
(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 byMapperConfig.getDefaultPropertyInclusion()
.getDefaultPropertyInclusions
(Class<?> baseType, AnnotatedClass actualClass) Helper method that may be called to see if there are property inclusion definitions from annotations (viaAnnotatedClass
).final JsonSetter.Value
Accessor for the baseline setter info used as the global baseline, not considering possible per-type overrides.final VisibilityChecker<?>
Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers).final VisibilityChecker<?>
getDefaultVisibilityChecker
(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).final PropertyName
final String
Deprecated.final SubtypeResolver
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).final int
Test-only method -- does not reflect possibly open-ended set that external mix-in resolver might provide.final T
with
(Base64Variant base64) Method for constructing and returning a new instance with different defaultBase64Variant
to use with base64-encoded binary values.final T
Method for constructing and returning a new instance with differentAnnotationIntrospector
to use (replacing old one).abstract T
with
(ContextAttributes attrs) Method for constructing an instance that has specified contextual attributes.final T
Method for constructing and returning a new instance with differentHandlerInstantiator
to use.final T
Method for constructing and returning a new instance with differentPropertyNamingStrategy
to use.final T
Method for constructing and returning a new instance with differentClassIntrospector
to use.abstract T
with
(SubtypeResolver str) Method for constructing and returning a new instance with differentSubtypeResolver
to use.final T
with
(TypeResolverBuilder<?> trb) Method for constructing and returning a new instance with differentTypeResolverBuilder
to use.final T
with
(MapperFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.final T
with
(MapperFeature feature, boolean state) final T
Method for constructing and returning a new instance with differentPropertyNamingStrategy
to use.final T
with
(TypeFactory tf) Method for constructing and returning a new instance with differentTypeFactory
to use.with
(DateFormat df) Method for constructing and returning a new instance with differentDateFormat
to use.final T
Method for constructing and returning a new instance with different defaultLocale
to use for formatting.final T
Method for constructing and returning a new instance with different defaultTimeZone
to use for formatting of date values.final T
Method for constructing and returning a new instance with additionalAnnotationIntrospector
appended (as the lowest priority one)withAttribute
(Object key, Object value) Method for constructing an instance that has specified value for attribute for given key.withAttributes
(Map<?, ?> attributes) Method for constructing an instance that has only specified attributes, removing any attributes that exist before the call.final T
Method for constructing and returning a new instance with additionalAnnotationIntrospector
inserted (as the highest priority one)final T
without
(MapperFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.withoutAttribute
(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).withRootName
(String rootName) abstract T
Method for constructing and returning a new instance with different view to use.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.MapperConfig
canOverrideAccessModifiers, collectFeatureDefaults, compileString, constructSpecializedType, constructType, constructType, getAccessorNaming, getAnnotationIntrospector, getBase64Variant, getClassIntrospector, getDateFormat, getDefaultInclusion, getDefaultPropertyInclusion, getDefaultTyper, getHandlerInstantiator, getLocale, getPolymorphicTypeValidator, getPropertyNamingStrategy, getTimeZone, getTypeFactory, hasExplicitTimeZone, hasMapperFeatures, introspectClassAnnotations, introspectClassAnnotations, introspectDirectClassAnnotations, introspectDirectClassAnnotations, isAnnotationProcessingEnabled, isEnabled, shouldSortPropertiesAlphabetically, typeIdResolverInstance, typeResolverBuilderInstance, useRootWrapping
-
Field Details
-
EMPTY_OVERRIDE
- Since:
- 2.9
-
_mixIns
Mix-in annotation mappings to use, if any: immutable, cannot be changed once defined.- Since:
- 2.6
-
_subtypeResolver
Registered concrete subtypes that can be used instead of (or in addition to) ones declared using annotations.Note that instances are stateful and as such may need to be copied, and may NOT be demoted down to
BaseSettings
. -
_rootName
Explicitly defined root name to use, if any; if empty String, will disable root-name wrapping; if null, will use defaults -
_view
View to use for filtering out properties to serialize or deserialize. Null if none (will also be assigned null ifObject.class
is defined), meaning that all properties are to be included. -
_attributes
Contextual attributes accessible (get and set) during processing, on per-call basis.- Since:
- 2.3
-
_rootNames
Simple cache used for finding out possible root name for root name wrapping.Note that instances are stateful (for caching) and as such may need to be copied, and may NOT be demoted down to
BaseSettings
.- Since:
- 2.6
-
_configOverrides
Configuration overrides to apply, keyed by type of property.- Since:
- 2.8
-
-
Constructor Details
-
MapperConfigBase
protected MapperConfigBase(BaseSettings base, SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames, ConfigOverrides configOverrides) Constructor used when creating a new instance (compared to that of creating fluent copies)- Since:
- 2.8
-
MapperConfigBase
protected MapperConfigBase(MapperConfigBase<CFG, T> src, SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames, ConfigOverrides configOverrides) Copy constructor usually called to make a copy for use by ObjectMapper that is copied.- Since:
- 2.11.2
-
MapperConfigBase
Pass-through constructor used when no changes are needed to the base class. -
MapperConfigBase
-
MapperConfigBase
-
MapperConfigBase
-
MapperConfigBase
-
MapperConfigBase
-
MapperConfigBase
- Since:
- 2.1
-
MapperConfigBase
- Since:
- 2.3
-
-
Method Details
-
_withBase
- Since:
- 2.9 (in this case, demoted from sub-classes)
-
_withMapperFeatures
- Since:
- 2.9 (in this case, demoted from sub-classes)
-
with
Fluent factory method that will construct and return a new configuration object instance with specified features enabled.- Specified by:
with
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
without
Fluent factory method that will construct and return a new configuration object instance with specified features disabled.- Specified by:
without
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
with
- Specified by:
with
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
with
Method for constructing and returning a new instance with differentAnnotationIntrospector
to use (replacing old one).NOTE: make sure to register new instance with
ObjectMapper
if directly calling this method. -
withAppendedAnnotationIntrospector
Method for constructing and returning a new instance with additionalAnnotationIntrospector
appended (as the lowest priority one) -
withInsertedAnnotationIntrospector
Method for constructing and returning a new instance with additionalAnnotationIntrospector
inserted (as the highest priority one) -
with
Method for constructing and returning a new instance with differentClassIntrospector
to use.NOTE: make sure to register new instance with
ObjectMapper
if directly calling this method. -
with
Method for constructing an instance that has specified contextual attributes.- Since:
- 2.3
-
withAttributes
Method for constructing an instance that has only specified attributes, removing any attributes that exist before the call.- Since:
- 2.3
-
withAttribute
Method for constructing an instance that has specified value for attribute for given key.- Since:
- 2.3
-
withoutAttribute
Method for constructing an instance that has no value for attribute for given key.- Since:
- 2.3
-
with
Method for constructing and returning a new instance with differentTypeFactory
to use. -
with
Method for constructing and returning a new instance with differentTypeResolverBuilder
to use. -
with
Method for constructing and returning a new instance with differentPropertyNamingStrategy
to use.NOTE: make sure to register new instance with
ObjectMapper
if directly calling this method. -
with
Method for constructing and returning a new instance with differentPropertyNamingStrategy
to use.- Since:
- 2.12
-
with
Method for constructing and returning a new instance with differentHandlerInstantiator
to use.NOTE: make sure to register new instance with
ObjectMapper
if directly calling this method. -
with
Method for constructing and returning a new instance with different defaultBase64Variant
to use with base64-encoded binary values. -
with
Method for constructing and returning a new instance with differentDateFormat
to use.NOTE: non-final since
SerializationConfig
needs to override this -
with
Method for constructing and returning a new instance with different defaultLocale
to use for formatting. -
with
Method for constructing and returning a new instance with different defaultTimeZone
to use for formatting of date values. -
withRootName
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
-
with
Method for constructing and returning a new instance with differentSubtypeResolver
to use.NOTE: make sure to register new instance with
ObjectMapper
if directly calling this method. -
withView
Method for constructing and returning a new instance with different view to use. -
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getRootName
Deprecated.Since 2.6 usegetFullRootName()
instead. -
getFullRootName
- Since:
- 2.6
-
getActiveView
Description copied from class:MapperConfig
Accessor for finding currently active view, if any (null if none)- Specified by:
getActiveView
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getConfigOverride
Description copied from class:MapperConfig
Accessor for findingConfigOverride
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>> - Returns:
- Override object to use for the type, never null (but may be empty)
-
findConfigOverride
Description copied from class:MapperConfig
Accessor for findingConfigOverride
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>> - Returns:
- Override object to use for the type, if defined; null if none.
-
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getDefaultPropertyInclusion
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 byMapperConfig.getDefaultPropertyInclusion()
.- Specified by:
getDefaultPropertyInclusion
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getDefaultInclusion
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 byMapperConfig.getDefaultPropertyInclusion()
.- Specified by:
getDefaultInclusion
in classMapperConfig<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
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getDefaultPropertyIgnorals
Description copied from class:MapperConfig
Accessor for default property ignorals to use, if any, for given base type, based on config overrides settings (seeMapperConfig.findConfigOverride(Class)
).- Specified by:
getDefaultPropertyIgnorals
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getDefaultPropertyIgnorals
public final JsonIgnoreProperties.Value getDefaultPropertyIgnorals(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 (viaAnnotatedClass
) or through "config overrides". If both exist, config overrides have precedence over class annotations.- Specified by:
getDefaultPropertyIgnorals
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getDefaultPropertyInclusions
public final JsonIncludeProperties.Value getDefaultPropertyInclusions(Class<?> baseType, AnnotatedClass actualClass) Description copied from class:MapperConfig
Helper method that may be called to see if there are property inclusion definitions from annotations (viaAnnotatedClass
). TODO: config override.- Specified by:
getDefaultPropertyInclusions
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
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 (usingJsonAutoDetect
annotation)- Specified by:
getDefaultVisibilityChecker
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
getDefaultVisibilityChecker
public final VisibilityChecker<?> getDefaultVisibilityChecker(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 byMapperConfig.getDefaultVisibilityChecker()
, but then modified by possible class annotation (seeJsonAutoDetect
) and/or per-type config override (seeConfigOverride.getVisibility()
).- Specified by:
getDefaultVisibilityChecker
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>> - Returns:
- Global base settings; never null
-
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 classMapperConfig<T extends MapperConfigBase<CFG,
T>> - Returns:
- Global base settings, if any; `null` if none.
-
getDefaultMergeable
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 classMapperConfig<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
- Specified by:
findRootName
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
findRootName
- Specified by:
findRootName
in classMapperConfig<T extends MapperConfigBase<CFG,
T>>
-
findMixInClassFor
Method that will check if there are "mix-in" classes (with mix-in annotations) for given class- Specified by:
findMixInClassFor
in interfaceClassIntrospector.MixInResolver
-
copy
Description copied from interface:ClassIntrospector.MixInResolver
Method called to create a new, non-shared copy, to be used by differentObjectMapper
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 interfaceClassIntrospector.MixInResolver
-
mixInCount
public final int mixInCount()Test-only method -- does not reflect possibly open-ended set that external mix-in resolver might provide.
-
getFullRootName()
instead.