jackson-databind 2.16.0 · com.fasterxml.jackson.databind.cfg.MapperBuilder

Modifier and Type	Field and Description
protected final M	_mapper

Access	Constructor and Description
protected	MapperBuilder(M mapper)

Method Summary

Modifier and Type	Method and Description
protected final B	_this()
public B	Returns: Builder instance itself to allow chaining accessorNaming(AccessorNamingStrategy.Provider Strategy instance to use; if null, use the default implementation s) Method for configuring `AccessorNamingStrategy` to use for auto-detecting accessor ("getter") and mutator ("setter") methods based on naming of methods.
public B	activateDefaultTyping(PolymorphicTypeValidator subtypeValidator) Convenience method that is equivalent to calling activateDefaultTyping(subtypeValidator, DefaultTyping.OBJECT_AND_NON_CONCRETE);
public B	activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping dti) Convenience method that is equivalent to calling activateDefaultTyping(subtypeValidator, dti, JsonTypeInfo.As.WRAPPER_ARRAY);
public B	activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping Defines kinds of types for which additional type information is added; see `DefaultTyping` for more information. applicability, JsonTypeInfo.As includeAs) Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated with `com.fasterxml.jackson.annotation.JsonTypeInfo`).
public B	activateDefaultTypingAsProperty(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, String propertyName) Method for enabling automatic inclusion of type information -- needed for proper deserialization of polymorphic types (unless types have been annotated with `com.fasterxml.jackson.annotation.JsonTypeInfo`) -- using "As.PROPERTY" inclusion mechanism and specified property name to use for inclusion (default being "@class" since default type information always uses class name as type identifier) Note choice of `PolymorphicTypeValidator` to pass is critical for security as allowing all subtypes can be risky for untrusted content.
public B	addHandler(DeserializationProblemHandler h) Method used for adding a `DeserializationProblemHandler` for this builder, at the head of the list (meaning it has priority over handler registered earlier).
public B	Returns: This builder instance to allow call chaining addMixIn(Class<?> Target class on which to add annotations target, Class<?> Class that has annotations to add mixinSource) Method to use for defining mix-in annotations to use for augmenting annotations that classes have, for purpose of configuration serialization and/or deserialization processing.
public B	addModule(Module module)
public B	addModules(Module... modules)
public B	addModules(Iterable<? extends Module> modules)
public B	annotationIntrospector(AnnotationIntrospector intr) Method for replacing `AnnotationIntrospector` used by the mapper instance to be built.
public M	build() Method to call to create actual mapper instance.
public B	cacheProvider(CacheProvider cacheProvider)
public B	clearProblemHandlers() Method that may be used to remove all `DeserializationProblemHandler`s added to this builder (if any).
public B	configure(MapperFeature feature, boolean state)
public B	configure(SerializationFeature feature, boolean state)
public B	configure(DeserializationFeature feature, boolean state)
public B	configure(DatatypeFeature feature, boolean state)
public B	configure(JsonParser.Feature feature, boolean state)
public B	configure(JsonGenerator.Feature feature, boolean state)
public B	configure(StreamReadFeature feature, boolean state)
public B	configure(StreamWriteFeature feature, boolean state)
public B	constructorDetector(ConstructorDetector cd) Method for specifying `ConstructorDetector` to use for determining some aspects of creator auto-detection (specifically auto-detection of constructor, and in particular behavior with single-argument constructors).
public B	deactivateDefaultTyping() Method for disabling automatic inclusion of type information; if so, only explicitly annotated types (ones with `com.fasterxml.jackson.annotation.JsonTypeInfo`) will have additional embedded type information.
public B	Returns: This Builder instance to allow call chaining defaultAttributes(ContextAttributes Default instance to use: may not be `null`. attrs) Method for replacing default `ContextAttributes` that the mapper uses: usually one initialized with a set of default shared attributes, but potentially also with a custom implementation.
public B	Returns: This builder instance to allow call chaining defaultBase64Variant(Base64Variant Base64 variant to use v) Method that will configure default `Base64Variant` that `byte[]` serializers and deserializers will use.
public B	defaultDateFormat(DateFormat df) Method for configuring the default `DateFormat` to use when serializing time values as Strings, and deserializing from JSON Strings.
public B	defaultLeniency(Boolean b) Method for setting default Setter configuration, regarding things like merging, null-handling; used for properties for which there are no per-type or per-property overrides (via annotations or config overrides).
public B	defaultLocale(Locale locale) Method for overriding default locale to use for formatting.
public B	defaultMergeable(Boolean b) Method for setting default Setter configuration, regarding things like merging, null-handling; used for properties for which there are no per-type or per-property overrides (via annotations or config overrides).
public B	defaultPrettyPrinter(PrettyPrinter pp)
public B	Returns: This builder instance to allow call chaining defaultPropertyInclusion(JsonInclude.Value Default property inclusion to set incl) Method for configured default property inclusion to use for serialization.
public B	defaultSetterInfo(JsonSetter.Value v)
public B	defaultTimeZone(TimeZone tz) Method for overriding default TimeZone to use for formatting.
public B	disable(MapperFeature... features)
public B	disable(SerializationFeature... features)
public B	disable(DeserializationFeature... features)
public B	disable(DatatypeFeature... features)
public B	disable(JsonParser.Feature... features)
public B	disable(JsonGenerator.Feature... features)
public B	disable(StreamReadFeature... features)
public B	disable(StreamWriteFeature... features)
public B	enable(MapperFeature... features)
public B	enable(SerializationFeature... features)
public B	enable(DeserializationFeature... features)
public B	enable(DatatypeFeature... features)
public B	enable(JsonParser.Feature... features)
public B	enable(JsonGenerator.Feature... features)
public B	enable(StreamReadFeature... features)
public B	enable(StreamWriteFeature... features)
public B	filterProvider(FilterProvider prov) Method for configuring this mapper to use specified `FilterProvider` for mapping Filter Ids to actual filter instances.
public B	findAndAddModules() Convenience method that is functionally equivalent to: `addModules(builder.findModules());` As with `findModules()`, no caching is done for modules, so care needs to be taken to either create and share a single mapper instance; or to cache introspected set of modules.
public static List<Module>	findModules() Method for locating available methods, using JDK `ServiceLoader` facility, along with module-provided SPI.
public static List<Module>	findModules(ClassLoader classLoader) Method for locating available methods, using JDK `ServiceLoader` facility, along with module-provided SPI.
public B	Returns: Builder instance itself to allow chaining handlerInstantiator(HandlerInstantiator Instantiator to use; if null, use the default implementation hi) Method for configuring `HandlerInstantiator` to use for creating instances of handlers (such as serializers, deserializers, type and type id resolvers), given a class.
public B	injectableValues(InjectableValues v)
public boolean	isEnabled(MapperFeature f)
public boolean	isEnabled(DeserializationFeature f)
public boolean	isEnabled(SerializationFeature f)
public boolean	isEnabled(JsonParser.Feature f)
public boolean	isEnabled(JsonGenerator.Feature f)
public B	nodeFactory(JsonNodeFactory f)
public B	polymorphicTypeValidator(PolymorphicTypeValidator ptv) Method for assigning `PolymorphicTypeValidator` to use for validating subtypes when using Class name - based polymorphic deserialization using annotations (validator used with "Default Typing" is specified by passing in `activateDefaultTyping(PolymorphicTypeValidator)` instead).
public B	Returns: Builder instance itself to allow chaining propertyNamingStrategy(PropertyNamingStrategy Strategy instance to use; if null, use the default implementation s) Method for configuring `PropertyNamingStrategy` to use for adapting POJO property names (internal) into content property names (external)
public B	registerSubtypes(Class<?>... subtypes)
public B	registerSubtypes(NamedType... subtypes)
public B	registerSubtypes(Collection<Class<?>> subtypes)
public B	Returns: This builder instance to allow call chaining removeMixIn(Class<?> Target class for which no mix-ins should remain after call target) Method that allows making sure that specified `target` class does not have associated mix-in annotations: basically can be used to undo an earlier call to `addMixIn`.
private static <T> ServiceLoader<T>	secureGetServiceLoader(final Class<T> clazz, final ClassLoader classLoader)
public B	Returns: This builder instance to allow call chaining serializationInclusion(JsonInclude.Include Default property inclusion to set incl) Method for configured default property inclusion to use for serialization.
public B	serializerFactory(SerializerFactory f)
public B	setDefaultTyping(TypeResolverBuilder<?> Type information inclusion handler typer) Method for enabling automatic inclusion of type information, using specified handler object for determining which types this affects, as well as details of how information is embedded.
public TokenStreamFactory	streamFactory()
public B	subtypeResolver(SubtypeResolver r)
public B	typeFactory(TypeFactory f)
public B	visibility(VisibilityChecker<?> vc)
public B	visibility(PropertyAccessor forMethod, JsonAutoDetect.Visibility visibility)
public B	withCoercionConfig(LogicalType forType, Consumer<MutableCoercionConfig> handler) Method for changing coercion config for specific logical types, through callback to specific handler.
public B	withCoercionConfig(Class<?> forType, Consumer<MutableCoercionConfig> handler) Method for changing coercion config for specific physical type, through callback to specific handler.
public B	withCoercionConfigDefaults(Consumer<MutableCoercionConfig> handler) Method for changing target-type-independent coercion configuration defaults.
public B	withConfigOverride(Class<?> Type to change config overrides for forType, Consumer<MutableConfigOverride> Function to call with `MutableConfigOverride` handler) Method for changing config overrides for specific type, through callback to specific handler.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_mapper	back to summary
protected final M _mapper

MapperBuilder	back to summary
protected MapperBuilder(M mapper)

Method Detail

_this	back to summary
protected final B _this() Annotations @SuppressWarnings:unchecked

accessorNaming back to summary

accessorNaming	back to summary
public B accessorNaming(AccessorNamingStrategy.Provider s) Method for configuring `AccessorNamingStrategy` to use for auto-detecting accessor ("getter") and mutator ("setter") methods based on naming of methods. Parameters s:AccessorNamingStrategy.Provider Strategy instance to use; if null, use the default implementation Returns:B Builder instance itself to allow chaining Since 2.12

public B accessorNaming(AccessorNamingStrategy.Provider s)

Method for configuring AccessorNamingStrategy to use for auto-detecting accessor ("getter") and mutator ("setter") methods based on naming of methods.

Parameters

s:AccessorNamingStrategy.Provider: Strategy instance to use; if null, use the default implementation

Returns:B

Builder instance itself to allow chaining

Since

2.12

activateDefaultTyping back to summary

activateDefaultTyping	back to summary
public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator) Convenience method that is equivalent to calling activateDefaultTyping(subtypeValidator, DefaultTyping.OBJECT_AND_NON_CONCRETE); Note choice of `PolymorphicTypeValidator` to pass is critical for security as allowing all subtypes can be risky for untrusted content.

public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator)

Convenience method that is equivalent to calling

  activateDefaultTyping(subtypeValidator, DefaultTyping.OBJECT_AND_NON_CONCRETE);

Note

choice of PolymorphicTypeValidator to pass is critical for security as allowing all subtypes can be risky for untrusted content.

activateDefaultTyping back to summary

activateDefaultTyping	back to summary
public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping dti) Convenience method that is equivalent to calling activateDefaultTyping(subtypeValidator, dti, JsonTypeInfo.As.WRAPPER_ARRAY); Note choice of `PolymorphicTypeValidator` to pass is critical for security as allowing all subtypes can be risky for untrusted content.

public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping dti)

Convenience method that is equivalent to calling

  activateDefaultTyping(subtypeValidator, dti, JsonTypeInfo.As.WRAPPER_ARRAY);

Note

choice of PolymorphicTypeValidator to pass is critical for security as allowing all subtypes can be risky for untrusted content.

activateDefaultTyping back to summary

activateDefaultTyping	back to summary
public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, JsonTypeInfo.As includeAs) Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated with `com.fasterxml.jackson.annotation.JsonTypeInfo`). Note use of `JsonTypeInfo.As#EXTERNAL_PROPERTY` NOT SUPPORTED; and attempts of do so will throw an `IllegalArgumentException` to make this limitation explicit. Note choice of `PolymorphicTypeValidator` to pass is critical for security as allowing all subtypes can be risky for untrusted content. Parameters applicability:ObjectMapper.DefaultTyping Defines kinds of types for which additional type information is added; see `DefaultTyping` for more information.

public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, JsonTypeInfo.As includeAs)

Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated with com.fasterxml.jackson.annotation.JsonTypeInfo).

Note

use of JsonTypeInfo.As#EXTERNAL_PROPERTY NOT SUPPORTED; and attempts of do so will throw an IllegalArgumentException to make this limitation explicit.

Note

choice of PolymorphicTypeValidator to pass is critical for security as allowing all subtypes can be risky for untrusted content.

Parameters

applicability:ObjectMapper.DefaultTyping: Defines kinds of types for which additional type information is added; see DefaultTyping for more information.

activateDefaultTypingAsProperty back to summary

activateDefaultTypingAsProperty	back to summary
public B activateDefaultTypingAsProperty(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, String propertyName) Method for enabling automatic inclusion of type information -- needed for proper deserialization of polymorphic types (unless types have been annotated with `com.fasterxml.jackson.annotation.JsonTypeInfo`) -- using "As.PROPERTY" inclusion mechanism and specified property name to use for inclusion (default being "@class" since default type information always uses class name as type identifier) Note choice of `PolymorphicTypeValidator` to pass is critical for security as allowing all subtypes can be risky for untrusted content.

public B activateDefaultTypingAsProperty(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, String propertyName)

Method for enabling automatic inclusion of type information -- needed for proper deserialization of polymorphic types (unless types have been annotated with com.fasterxml.jackson.annotation.JsonTypeInfo) -- using "As.PROPERTY" inclusion mechanism and specified property name to use for inclusion (default being "@class" since default type information always uses class name as type identifier)

Note

choice of PolymorphicTypeValidator to pass is critical for security as allowing all subtypes can be risky for untrusted content.

addHandler	back to summary
public B addHandler(DeserializationProblemHandler h) Method used for adding a `DeserializationProblemHandler` for this builder, at the head of the list (meaning it has priority over handler registered earlier).

addMixIn back to summary

addMixIn	back to summary
public B addMixIn(Class<?> target, Class<?> mixinSource) Method to use for defining mix-in annotations to use for augmenting annotations that classes have, for purpose of configuration serialization and/or deserialization processing. Mixing in is done when introspecting class annotations and properties. Annotations from "mixin" class (and its supertypes) will override annotations that target classes (and their super-types) have. Note that standard mixin handler implementations will only allow a single mix-in source class per target, so if there was a previous mix-in defined target it will be cleared. This also means that you can remove mix-in definition by specifying `mixinSource` of `null` (although preferred mechanism is `removeMixIn`) Parameters target:Class<?> Target class on which to add annotations mixinSource:Class<?> Class that has annotations to add Returns:B This builder instance to allow call chaining

public B addMixIn(Class<?> target, Class<?> mixinSource)

Method to use for defining mix-in annotations to use for augmenting annotations that classes have, for purpose of configuration serialization and/or deserialization processing. Mixing in is done when introspecting class annotations and properties. Annotations from "mixin" class (and its supertypes) will override annotations that target classes (and their super-types) have.

Note that standard mixin handler implementations will only allow a single mix-in source class per target, so if there was a previous mix-in defined target it will be cleared. This also means that you can remove mix-in definition by specifying mixinSource of null (although preferred mechanism is removeMixIn)

Parameters

target:Class<?>: Target class on which to add annotations
mixinSource:Class<?>: Class that has annotations to add

Returns:B

This builder instance to allow call chaining

addModule	back to summary
public B addModule(Module module)

addModules	back to summary
public B addModules(Module... modules)

addModules	back to summary
public B addModules(Iterable<? extends Module> modules)

annotationIntrospector back to summary

annotationIntrospector	back to summary
public B annotationIntrospector(AnnotationIntrospector intr) Method for replacing `AnnotationIntrospector` used by the mapper instance to be built. Note that doing this will replace the current introspector, which may lead to unavailability of core Jackson annotations. If you want to combine handling of multiple introspectors, have a look at `com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair`. See Also `com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair`

public B annotationIntrospector(AnnotationIntrospector intr)

Method for replacing AnnotationIntrospector used by the mapper instance to be built. Note that doing this will replace the current introspector, which may lead to unavailability of core Jackson annotations. If you want to combine handling of multiple introspectors, have a look at com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair.

See Also: com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair

build	back to summary
public M build() Method to call to create actual mapper instance. Implementation detail: in 2.10 (but not 3.x) underlying mapper is eagerly constructed when builder is constructed, and method simply returns that instance.

build

back to summary

public M build()

Method to call to create actual mapper instance.

Implementation detail: in 2.10 (but not 3.x) underlying mapper is eagerly constructed when builder is constructed, and method simply returns that instance.

cacheProvider	back to summary
public B cacheProvider(CacheProvider cacheProvider) Since 2.16

clearProblemHandlers	back to summary
public B clearProblemHandlers() Method that may be used to remove all `DeserializationProblemHandler`s added to this builder (if any).

configure	back to summary
public B configure(MapperFeature feature, boolean state) Annotations @SuppressWarnings:deprecation

configure	back to summary
public B configure(SerializationFeature feature, boolean state)

configure	back to summary
public B configure(DeserializationFeature feature, boolean state)

configure	back to summary
public B configure(DatatypeFeature feature, boolean state)

configure	back to summary
public B configure(JsonParser.Feature feature, boolean state)

configure	back to summary
public B configure(JsonGenerator.Feature feature, boolean state)

configure	back to summary
public B configure(StreamReadFeature feature, boolean state)

configure	back to summary
public B configure(StreamWriteFeature feature, boolean state)

constructorDetector back to summary

constructorDetector	back to summary
public B constructorDetector(ConstructorDetector cd) Method for specifying `ConstructorDetector` to use for determining some aspects of creator auto-detection (specifically auto-detection of constructor, and in particular behavior with single-argument constructors). Since 2.12

public B constructorDetector(ConstructorDetector cd)

Method for specifying ConstructorDetector to use for determining some aspects of creator auto-detection (specifically auto-detection of constructor, and in particular behavior with single-argument constructors).

Since: 2.12

deactivateDefaultTyping	back to summary
public B deactivateDefaultTyping() Method for disabling automatic inclusion of type information; if so, only explicitly annotated types (ones with `com.fasterxml.jackson.annotation.JsonTypeInfo`) will have additional embedded type information.

defaultAttributes back to summary

defaultAttributes	back to summary
public B defaultAttributes(ContextAttributes attrs) Method for replacing default `ContextAttributes` that the mapper uses: usually one initialized with a set of default shared attributes, but potentially also with a custom implementation. Note instance specified will need to be thread-safe for usage, similar to the default (`ContextAttributes.Impl`). Parameters attrs:ContextAttributes Default instance to use: may not be `null`. Returns:B This Builder instance to allow call chaining

public B defaultAttributes(ContextAttributes attrs)

Method for replacing default ContextAttributes that the mapper uses: usually one initialized with a set of default shared attributes, but potentially also with a custom implementation.

Note

instance specified will need to be thread-safe for usage, similar to the default (ContextAttributes.Impl).

Parameters

attrs:ContextAttributes: Default instance to use: may not be null.

Returns:B

This Builder instance to allow call chaining

defaultBase64Variant back to summary

defaultBase64Variant	back to summary
public B defaultBase64Variant(Base64Variant v) Method that will configure default `Base64Variant` that `byte[]` serializers and deserializers will use. Parameters v:Base64Variant Base64 variant to use Returns:B This builder instance to allow call chaining

public B defaultBase64Variant(Base64Variant v)

Method that will configure default Base64Variant that byte[] serializers and deserializers will use.

Parameters

v:Base64Variant: Base64 variant to use

Returns:B

This builder instance to allow call chaining

defaultDateFormat	back to summary
public B defaultDateFormat(DateFormat df) Method for configuring the default `DateFormat` to use when serializing time values as Strings, and deserializing from JSON Strings. If you need per-request configuration, factory methods in `ObjectReader` and `ObjectWriter` instead.

defaultLeniency	back to summary
public B defaultLeniency(Boolean b) Method for setting default Setter configuration, regarding things like merging, null-handling; used for properties for which there are no per-type or per-property overrides (via annotations or config overrides).

defaultLocale	back to summary
public B defaultLocale(Locale locale) Method for overriding default locale to use for formatting. Default value used is `Locale#getDefault()`.

defaultMergeable	back to summary
public B defaultMergeable(Boolean b) Method for setting default Setter configuration, regarding things like merging, null-handling; used for properties for which there are no per-type or per-property overrides (via annotations or config overrides).

defaultPrettyPrinter	back to summary
public B defaultPrettyPrinter(PrettyPrinter pp)

defaultPropertyInclusion	back to summary
public B defaultPropertyInclusion(JsonInclude.Value incl) Method for configured default property inclusion to use for serialization. Parameters incl:JsonInclude.Value Default property inclusion to set Returns:B This builder instance to allow call chaining Since 2.11

defaultPropertyInclusion

back to summary

public B defaultPropertyInclusion(JsonInclude.Value incl)

Method for configured default property inclusion to use for serialization.

Parameters

incl:JsonInclude.Value: Default property inclusion to set

Returns:B

This builder instance to allow call chaining

Since

2.11

defaultSetterInfo	back to summary
public B defaultSetterInfo(JsonSetter.Value v)

defaultTimeZone	back to summary
public B defaultTimeZone(TimeZone tz) Method for overriding default TimeZone to use for formatting. Default value used is UTC (NOT default TimeZone of JVM).

disable	back to summary
public B disable(MapperFeature... features) Annotations @SuppressWarnings:deprecation

disable	back to summary
public B disable(SerializationFeature... features)

disable	back to summary
public B disable(DeserializationFeature... features)

disable	back to summary
public B disable(DatatypeFeature... features)

disable	back to summary
public B disable(JsonParser.Feature... features)

disable	back to summary
public B disable(JsonGenerator.Feature... features)

disable	back to summary
public B disable(StreamReadFeature... features)

disable	back to summary
public B disable(StreamWriteFeature... features)

enable	back to summary
public B enable(MapperFeature... features) Annotations @SuppressWarnings:deprecation

enable	back to summary
public B enable(SerializationFeature... features)

enable	back to summary
public B enable(DeserializationFeature... features)

enable	back to summary
public B enable(DatatypeFeature... features)

enable	back to summary
public B enable(JsonParser.Feature... features)

enable	back to summary
public B enable(JsonGenerator.Feature... features)

enable	back to summary
public B enable(StreamReadFeature... features)

enable	back to summary
public B enable(StreamWriteFeature... features)

filterProvider back to summary

public B filterProvider(FilterProvider prov)

Method for configuring this mapper to use specified FilterProvider for mapping Filter Ids to actual filter instances.

Note that usually it is better to use method in ObjectWriter, but sometimes this method is more convenient. For example, some frameworks only allow configuring of ObjectMapper instances and not ObjectWriters.

findAndAddModules back to summary

public B findAndAddModules()

Convenience method that is functionally equivalent to: addModules(builder.findModules());

As with findModules(), no caching is done for modules, so care needs to be taken to either create and share a single mapper instance; or to cache introspected set of modules.

findModules back to summary

public static List<Module> findModules()

Method for locating available methods, using JDK ServiceLoader facility, along with module-provided SPI.

Note that method does not do any caching, so calls should be considered potentially expensive.

findModules back to summary

public static List<Module> findModules(ClassLoader classLoader)

Method for locating available methods, using JDK ServiceLoader facility, along with module-provided SPI.

Note that method does not do any caching, so calls should be considered potentially expensive.

handlerInstantiator back to summary

public B handlerInstantiator(HandlerInstantiator hi)

Method for configuring HandlerInstantiator to use for creating instances of handlers (such as serializers, deserializers, type and type id resolvers), given a class.

Parameters

hi:HandlerInstantiator: Instantiator to use; if null, use the default implementation

Returns:B

Builder instance itself to allow chaining

injectableValues	back to summary
public B injectableValues(InjectableValues v)

isEnabled	back to summary
public boolean isEnabled(MapperFeature f)

isEnabled	back to summary
public boolean isEnabled(DeserializationFeature f)

isEnabled	back to summary
public boolean isEnabled(SerializationFeature f)

isEnabled	back to summary
public boolean isEnabled(JsonParser.Feature f)

isEnabled	back to summary
public boolean isEnabled(JsonGenerator.Feature f)

nodeFactory	back to summary
public B nodeFactory(JsonNodeFactory f)

polymorphicTypeValidator back to summary

public B polymorphicTypeValidator(PolymorphicTypeValidator ptv)

Method for assigning PolymorphicTypeValidator to use for validating subtypes when using Class name - based polymorphic deserialization using annotations (validator used with "Default Typing" is specified by passing in activateDefaultTyping(PolymorphicTypeValidator) instead).

Validator will be called on validating types for which no default databind deserializer, or module-provided deserializer is found: typically this includes "POJO" (aka Bean) types, but not (for example) most container types.

Since: 2.10

propertyNamingStrategy back to summary

public B propertyNamingStrategy(PropertyNamingStrategy s)

Method for configuring PropertyNamingStrategy to use for adapting POJO property names (internal) into content property names (external)

Parameters

s:PropertyNamingStrategy: Strategy instance to use; if null, use the default implementation

Returns:B

Builder instance itself to allow chaining

registerSubtypes	back to summary
public B registerSubtypes(Class<?>... subtypes)

registerSubtypes	back to summary
public B registerSubtypes(NamedType... subtypes)

registerSubtypes	back to summary
public B registerSubtypes(Collection<Class<?>> subtypes)

removeMixIn back to summary

public B removeMixIn(Class<?> target)

Method that allows making sure that specified target class does not have associated mix-in annotations: basically can be used to undo an earlier call to addMixIn.

Note

removing mix-ins for given class does not try to remove possible mix-ins for any of its super classes and super interfaces; only direct mix-in addition, if any, is removed.

Parameters

target:Class<?>: Target class for which no mix-ins should remain after call

Returns:B

This builder instance to allow call chaining

Since

2.13

secureGetServiceLoader	back to summary
private static <T> ServiceLoader<T> secureGetServiceLoader(final Class<T> clazz, final ClassLoader classLoader)

serializationInclusion

back to summary

public B serializationInclusion(JsonInclude.Include incl)

Method for configured default property inclusion to use for serialization.

Parameters

incl:JsonInclude.Include: Default property inclusion to set

Returns:B

This builder instance to allow call chaining

serializerFactory	back to summary
public B serializerFactory(SerializerFactory f)

setDefaultTyping back to summary

public B setDefaultTyping(TypeResolverBuilder<?> typer)

Method for enabling automatic inclusion of type information, using specified handler object for determining which types this affects, as well as details of how information is embedded.

Note

use of Default Typing can be a potential security risk if incoming content comes from untrusted sources, so care should be taken to use a TypeResolverBuilder that can limit allowed classes to deserialize. Note in particular that com.fasterxml.jackson.databind.jsontype.impl.StdTypeResolverBuilder DOES NOT limit applicability but creates type (de)serializers for all types.

Parameters

typer:TypeResolverBuilder<?>: Type information inclusion handler

Since

2.12

streamFactory	back to summary
public TokenStreamFactory streamFactory()

subtypeResolver	back to summary
public B subtypeResolver(SubtypeResolver r)

typeFactory	back to summary
public B typeFactory(TypeFactory f)

visibility	back to summary
public B visibility(VisibilityChecker<?> vc)

visibility	back to summary
public B visibility(PropertyAccessor forMethod, JsonAutoDetect.Visibility visibility)

withCoercionConfig

back to summary

public B withCoercionConfig(LogicalType forType, Consumer<MutableCoercionConfig> handler)

Method for changing coercion config for specific logical types, through callback to specific handler.

Since: 2.13

withCoercionConfig

back to summary

public B withCoercionConfig(Class<?> forType, Consumer<MutableCoercionConfig> handler)

Method for changing coercion config for specific physical type, through callback to specific handler.

Since: 2.13

withCoercionConfigDefaults

back to summary

public B withCoercionConfigDefaults(Consumer<MutableCoercionConfig> handler)

Method for changing target-type-independent coercion configuration defaults.

Since: 2.13

withConfigOverride back to summary

public B withConfigOverride(Class<?> forType, Consumer<MutableConfigOverride> handler)

Method for changing config overrides for specific type, through callback to specific handler.

Parameters

forType:Class<?>: Type to change config overrides for
handler:Consumer<MutableConfigOverride>: Function to call with MutableConfigOverride

Since

2.13

public abstract Class MapperBuilder<M extends com.fasterxml.jackson.databind.ObjectMapper, B extends com.fasterxml.jackson.databind.cfg.MapperBuilder<M, B>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail