public abstract Class MapperBuilder<M extends ObjectMapper, B extends MapperBuilder<M, B>>

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

Convenience method that is equivalent to calling

  activateDefaultTyping(subtypeValidator, DefaultTyping.OBJECT_AND_NON_CONCRETE);

Convenience method that is equivalent to calling

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

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

Parameters

applicability:ObjectMapper.DefaultTyping

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

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)

Method used for adding a DeserializationProblemHandler for this builder, at the head of the list (meaning it has priority over handler registered earlier).

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

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

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.

Since

2.16

Method that may be used to remove all DeserializationProblemHandlers added to this builder (if any).

Annotations

@SuppressWarnings:deprecation

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

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.

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.

Parameters

attrs:ContextAttributes

Default instance to use: may not be null.

Returns:B

This Builder instance to allow call chaining

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

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.

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

Method for overriding default locale to use for formatting. Default value used is Locale#getDefault().

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

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

Method for overriding default TimeZone to use for formatting. Default value used is UTC (NOT default TimeZone of JVM).

Annotations

@SuppressWarnings:deprecation

Annotations

@SuppressWarnings:deprecation

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.

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.

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.

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.

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

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

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

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.

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

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

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.

Parameters

typer:TypeResolverBuilder<?>

Type information inclusion handler

Since

2.12

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

Since

2.13

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

Since

2.13

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

Since

2.13

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