Jackson2ObjectMapperBuilder

java.lang.Object
- org.springframework.http.converter.json.Jackson2ObjectMapperBuilder

```
public class Jackson2ObjectMapperBuilder
extends java.lang.Object
```
A builder used to create ObjectMapper instances with a fluent API.
It customizes Jackson's default properties with the following ones:
- MapperFeature#DEFAULT_VIEW_INCLUSION is disabled
- DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES is disabled
Note that Jackson's JSR-310 and Joda-Time support modules will be registered automatically when available (and when Java 8 and Joda-Time themselves are available, respectively).
Tested against Jackson 2.2, 2.3, 2.4, 2.5, 2.6; compatible with Jackson 2.0 and higher.
Since:

4.1.1

Author:

Sebastien Deleuze, Juergen Hoeller, Tadaya Tsuyukubo

See Also:

build(), configure(ObjectMapper), Jackson2ObjectMapperFactoryBean

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class Jackson2ObjectMapperBuilder.XmlObjectMapperInitializer

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Jackson2ObjectMapperBuilder.XmlObjectMapperInitializer`

Field Summary

Fields
Modifier and Type	Field and Description
`private AnnotationIntrospector`	`annotationIntrospector`
`private ApplicationContext`	`applicationContext`
`private boolean`	`createXmlMapper`
`private java.text.DateFormat`	`dateFormat`
`private java.util.Map<java.lang.Class<?>,<any>>`	`deserializers`
`private java.util.Map<java.lang.Object,java.lang.Boolean>`	`features`
`private FilterProvider`	`filters`
`private boolean`	`findModulesViaServiceLoader`
`private boolean`	`findWellKnownModules`
`private HandlerInstantiator`	`handlerInstantiator`
`private java.util.Locale`	`locale`
`private java.util.Map<java.lang.Class<?>,java.lang.Class<?>>`	`mixIns`
`private java.lang.Class<? extends Module>[]`	`moduleClasses`
`private java.lang.ClassLoader`	`moduleClassLoader`
`private java.util.List<Module>`	`modules`
`private PropertyNamingStrategy`	`propertyNamingStrategy`
`private JsonInclude.Include`	`serializationInclusion`
`private java.util.Map<java.lang.Class<?>,<any>>`	`serializers`
`private java.util.TimeZone`	`timeZone`

Constructor Summary

Constructors
Constructor and Description

Jackson2ObjectMapperBuilder()

Constructors
Constructor and Description
`Jackson2ObjectMapperBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private <T> void`	`addDeserializers(SimpleModule module)`
`private <T> void`	`addSerializers(SimpleModule module)`
`Jackson2ObjectMapperBuilder`	`annotationIntrospector(AnnotationIntrospector annotationIntrospector)` Set an `AnnotationIntrospector` for both serialization and deserialization.
`Jackson2ObjectMapperBuilder`	`applicationContext(ApplicationContext applicationContext)` Set the Spring `ApplicationContext` in order to autowire Jackson handlers (`JsonSerializer`, `JsonDeserializer`, `KeyDeserializer`, `TypeResolverBuilder` and `TypeIdResolver`).
`Jackson2ObjectMapperBuilder`	`autoDetectFields(boolean autoDetectFields)` Shortcut for `MapperFeature#AUTO_DETECT_FIELDS` option.
`Jackson2ObjectMapperBuilder`	`autoDetectGettersSetters(boolean autoDetectGettersSetters)` Shortcut for `MapperFeature#AUTO_DETECT_SETTERS`/ `MapperFeature#AUTO_DETECT_GETTERS` option.
`<T extends ObjectMapper> T`	`build()` Build a new `ObjectMapper` instance.
`void`	`configure(ObjectMapper objectMapper)` Configure an existing `ObjectMapper` instance with this builder's settings.
`private void`	`configureFeature(ObjectMapper objectMapper, java.lang.Object feature, boolean enabled)`
`Jackson2ObjectMapperBuilder`	`createXmlMapper(boolean createXmlMapper)` If set to `true`, an `XmlMapper` will be created using its default constructor.
`private void`	`customizeDefaultFeatures(ObjectMapper objectMapper)`
`Jackson2ObjectMapperBuilder`	`dateFormat(java.text.DateFormat dateFormat)` Define the format for date/time with the given `DateFormat`.
`Jackson2ObjectMapperBuilder`	`defaultViewInclusion(boolean defaultViewInclusion)` Shortcut for `MapperFeature#DEFAULT_VIEW_INCLUSION` option.
`Jackson2ObjectMapperBuilder`	`deserializerByType(java.lang.Class<?> type, <any> deserializer)` Configure a custom deserializer for the given type.
`Jackson2ObjectMapperBuilder`	`deserializersByType(java.util.Map<java.lang.Class<?>,<any>> deserializers)` Configure custom deserializers for the given types.
`Jackson2ObjectMapperBuilder`	`failOnEmptyBeans(boolean failOnEmptyBeans)` Shortcut for `SerializationFeature#FAIL_ON_EMPTY_BEANS` option.
`Jackson2ObjectMapperBuilder`	`failOnUnknownProperties(boolean failOnUnknownProperties)` Shortcut for `DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES` option.
`Jackson2ObjectMapperBuilder`	`featuresToDisable(java.lang.Object... featuresToDisable)` Specify features to disable.
`Jackson2ObjectMapperBuilder`	`featuresToEnable(java.lang.Object... featuresToEnable)` Specify features to enable.
`Jackson2ObjectMapperBuilder`	`filters(FilterProvider filters)` Set the global filters to use in order to support `@JsonFilter` annotated POJO.
`Jackson2ObjectMapperBuilder`	`findModulesViaServiceLoader(boolean findModules)` Set whether to let Jackson find available modules via the JDK ServiceLoader, based on META-INF metadata in the classpath.
`Jackson2ObjectMapperBuilder`	`handlerInstantiator(HandlerInstantiator handlerInstantiator)` Customize the construction of Jackson handlers (`JsonSerializer`, `JsonDeserializer`, `KeyDeserializer`, `TypeResolverBuilder` and `TypeIdResolver`).
`Jackson2ObjectMapperBuilder`	`indentOutput(boolean indentOutput)` Shortcut for `SerializationFeature#INDENT_OUTPUT` option.
`static Jackson2ObjectMapperBuilder`	`json()` Obtain a `Jackson2ObjectMapperBuilder` instance in order to build a regular JSON `ObjectMapper` instance.
`Jackson2ObjectMapperBuilder`	`locale(java.util.Locale locale)` Override the default `Locale` to use for formatting.
`Jackson2ObjectMapperBuilder`	`locale(java.lang.String localeString)` Override the default `Locale` to use for formatting.
`Jackson2ObjectMapperBuilder`	`mixIn(java.lang.Class<?> target, java.lang.Class<?> mixinSource)` Add mix-in annotations to use for augmenting specified class or interface.
`Jackson2ObjectMapperBuilder`	`mixIns(java.util.Map<java.lang.Class<?>,java.lang.Class<?>> mixIns)` Add mix-in annotations to use for augmenting specified class or interface.
`Jackson2ObjectMapperBuilder`	`moduleClassLoader(java.lang.ClassLoader moduleClassLoader)` Set the ClassLoader to use for loading Jackson extension modules.
`Jackson2ObjectMapperBuilder`	`modules(java.util.List<Module> modules)` Set a complete list of modules to be registered with the `ObjectMapper`.
`Jackson2ObjectMapperBuilder`	`modules(Module... modules)` Specify one or more modules to be registered with the `ObjectMapper`.
`Jackson2ObjectMapperBuilder`	`modulesToInstall(Module... modules)` Specify one or more modules to be registered with the `ObjectMapper`.
`Jackson2ObjectMapperBuilder`	`propertyNamingStrategy(PropertyNamingStrategy propertyNamingStrategy)` Specify a `com.fasterxml.jackson.databind.PropertyNamingStrategy` to configure the `ObjectMapper` with.
`private void`	`registerWellKnownModulesIfAvailable(ObjectMapper objectMapper)`
`Jackson2ObjectMapperBuilder`	`serializationInclusion(JsonInclude.Include serializationInclusion)` Set a custom inclusion strategy for serialization.
`Jackson2ObjectMapperBuilder`	`serializerByType(java.lang.Class<?> type, <any> serializer)` Configure a custom serializer for the given type.
`Jackson2ObjectMapperBuilder`	`serializers(<any>... serializers)` Configure custom serializers.
`Jackson2ObjectMapperBuilder`	`serializersByType(java.util.Map<java.lang.Class<?>,<any>> serializers)` Configure custom serializers for the given types.
`Jackson2ObjectMapperBuilder`	`simpleDateFormat(java.lang.String format)` Define the date/time format with a `SimpleDateFormat`.
`Jackson2ObjectMapperBuilder`	`timeZone(java.lang.String timeZoneString)` Override the default `TimeZone` to use for formatting.
`Jackson2ObjectMapperBuilder`	`timeZone(java.util.TimeZone timeZone)` Override the default `TimeZone` to use for formatting.
`static Jackson2ObjectMapperBuilder`	`xml()` Obtain a `Jackson2ObjectMapperBuilder` instance in order to build an `XmlMapper` instance.

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

- Field Detail
  - createXmlMapper
```
private boolean createXmlMapper
```
  - dateFormat
```
private java.text.DateFormat dateFormat
```
  - locale
```
private java.util.Locale locale
```
  - timeZone
```
private java.util.TimeZone timeZone
```
  - annotationIntrospector
```
private AnnotationIntrospector annotationIntrospector
```
  - propertyNamingStrategy
```
private PropertyNamingStrategy propertyNamingStrategy
```
  - serializationInclusion
```
private JsonInclude.Include serializationInclusion
```
  - filters
```
private FilterProvider filters
```
  - mixIns
```
private final java.util.Map<java.lang.Class<?>,java.lang.Class<?>> mixIns
```
  - serializers
```
private final java.util.Map<java.lang.Class<?>,<any>> serializers
```
  - deserializers
```
private final java.util.Map<java.lang.Class<?>,<any>> deserializers
```
  - features
```
private final java.util.Map<java.lang.Object,java.lang.Boolean> features
```
  - modules
```
private java.util.List<Module> modules
```
  - moduleClasses
```
private java.lang.Class<? extends Module>[] moduleClasses
```
  - findModulesViaServiceLoader
```
private boolean findModulesViaServiceLoader
```
  - findWellKnownModules
```
private boolean findWellKnownModules
```
  - moduleClassLoader
```
private java.lang.ClassLoader moduleClassLoader
```
  - handlerInstantiator
```
private HandlerInstantiator handlerInstantiator
```
  - applicationContext
```
private ApplicationContext applicationContext
```
- Constructor Detail
  - Jackson2ObjectMapperBuilder
```
public Jackson2ObjectMapperBuilder()
```
- Method Detail
  - createXmlMapper
```
public Jackson2ObjectMapperBuilder createXmlMapper(boolean createXmlMapper)
```
    If set to true, an XmlMapper will be created using its default constructor. This is only applicable to build() calls, not to configure(ObjectMapper) calls.
  - dateFormat
```
public Jackson2ObjectMapperBuilder dateFormat(java.text.DateFormat dateFormat)
```
    Define the format for date/time with the given DateFormat.
    Note: Setting this property makes the exposed ObjectMapper non-thread-safe, according to Jackson's thread safety rules.
    
    See Also:
    
    simpleDateFormat(String)
  - simpleDateFormat
```
public Jackson2ObjectMapperBuilder simpleDateFormat(java.lang.String format)
```
    Define the date/time format with a SimpleDateFormat.
    Note: Setting this property makes the exposed ObjectMapper non-thread-safe, according to Jackson's thread safety rules.
    
    See Also:
    
    dateFormat(DateFormat)
  - locale
```
public Jackson2ObjectMapperBuilder locale(java.util.Locale locale)
```
    Override the default Locale to use for formatting. Default value used is Locale.getDefault().
    
    Since:
    
    4.1.5
  - locale
```
public Jackson2ObjectMapperBuilder locale(java.lang.String localeString)
```
    Override the default Locale to use for formatting. Default value used is Locale.getDefault().
    
    Parameters:
    
    localeString - the locale ID as a String representation
    
    Since:
    
    4.1.5
  - timeZone
```
public Jackson2ObjectMapperBuilder timeZone(java.util.TimeZone timeZone)
```
    Override the default TimeZone to use for formatting. Default value used is UTC (NOT local timezone).
    
    Since:
    
    4.1.5
  - timeZone
```
public Jackson2ObjectMapperBuilder timeZone(java.lang.String timeZoneString)
```
    Override the default TimeZone to use for formatting. Default value used is UTC (NOT local timezone).
    
    Parameters:
    
    timeZoneString - the zone ID as a String representation
    
    Since:
    
    4.1.5
  - annotationIntrospector
```
public Jackson2ObjectMapperBuilder annotationIntrospector(AnnotationIntrospector annotationIntrospector)
```
    Set an AnnotationIntrospector for both serialization and deserialization.
  - propertyNamingStrategy
```
public Jackson2ObjectMapperBuilder propertyNamingStrategy(PropertyNamingStrategy propertyNamingStrategy)
```
    Specify a com.fasterxml.jackson.databind.PropertyNamingStrategy to configure the ObjectMapper with.
  - serializationInclusion
```
public Jackson2ObjectMapperBuilder serializationInclusion(JsonInclude.Include serializationInclusion)
```
    Set a custom inclusion strategy for serialization.
    
    See Also:
    
    com.fasterxml.jackson.annotation.JsonInclude.Include
  - filters
```
public Jackson2ObjectMapperBuilder filters(FilterProvider filters)
```
    Set the global filters to use in order to support @JsonFilter annotated POJO.
    
    Since:
    
    4.2
    
    See Also:
    
    MappingJacksonValue.setFilters(FilterProvider)
  - mixIn
```
public Jackson2ObjectMapperBuilder mixIn(java.lang.Class<?> target,
                                         java.lang.Class<?> mixinSource)
```
    Add mix-in annotations to use for augmenting specified class or interface.
    
    Parameters:
    
    target - class (or interface) whose annotations to effectively override
    
    mixinSource - class (or interface) whose annotations are to be "added" to target's annotations as value
    
    Since:
    
    4.1.2
    
    See Also:
    
    com.fasterxml.jackson.databind.ObjectMapper#addMixInAnnotations(Class, Class)
  - mixIns
```
public Jackson2ObjectMapperBuilder mixIns(java.util.Map<java.lang.Class<?>,java.lang.Class<?>> mixIns)
```
    Add mix-in annotations to use for augmenting specified class or interface.
    
    Parameters:
    
    mixIns - Map of entries with target classes (or interface) whose annotations to effectively override as key and mix-in classes (or interface) whose annotations are to be "added" to target's annotations as value.
    
    Since:
    
    4.1.2
    
    See Also:
    
    com.fasterxml.jackson.databind.ObjectMapper#addMixInAnnotations(Class, Class)
  - serializers
```
public Jackson2ObjectMapperBuilder serializers(<any>... serializers)
```
    Configure custom serializers. Each serializer is registered for the type returned by JsonSerializer#handledType(), which must not be null.
    
    See Also:
    
    serializersByType(Map)
  - serializerByType
```
public Jackson2ObjectMapperBuilder serializerByType(java.lang.Class<?> type,
                                                    <any> serializer)
```
    Configure a custom serializer for the given type.
    
    Since:
    
    4.1.2
    
    See Also:
    
    #serializers(JsonSerializer...)
  - serializersByType
```
public Jackson2ObjectMapperBuilder serializersByType(java.util.Map<java.lang.Class<?>,<any>> serializers)
```
    Configure custom serializers for the given types.
    
    See Also:
    
    #serializers(JsonSerializer...)
  - deserializerByType
```
public Jackson2ObjectMapperBuilder deserializerByType(java.lang.Class<?> type,
                                                      <any> deserializer)
```
    Configure a custom deserializer for the given type.
    
    Since:
    
    4.1.2
  - deserializersByType
```
public Jackson2ObjectMapperBuilder deserializersByType(java.util.Map<java.lang.Class<?>,<any>> deserializers)
```
    Configure custom deserializers for the given types.
  - autoDetectFields
```
public Jackson2ObjectMapperBuilder autoDetectFields(boolean autoDetectFields)
```
    Shortcut for MapperFeature#AUTO_DETECT_FIELDS option.
  - autoDetectGettersSetters
```
public Jackson2ObjectMapperBuilder autoDetectGettersSetters(boolean autoDetectGettersSetters)
```
    Shortcut for MapperFeature#AUTO_DETECT_SETTERS/ MapperFeature#AUTO_DETECT_GETTERS option.
  - defaultViewInclusion
```
public Jackson2ObjectMapperBuilder defaultViewInclusion(boolean defaultViewInclusion)
```
    Shortcut for MapperFeature#DEFAULT_VIEW_INCLUSION option.
  - failOnUnknownProperties
```
public Jackson2ObjectMapperBuilder failOnUnknownProperties(boolean failOnUnknownProperties)
```
    Shortcut for DeserializationFeature#FAIL_ON_UNKNOWN_PROPERTIES option.
  - failOnEmptyBeans
```
public Jackson2ObjectMapperBuilder failOnEmptyBeans(boolean failOnEmptyBeans)
```
    Shortcut for SerializationFeature#FAIL_ON_EMPTY_BEANS option.
  - indentOutput
```
public Jackson2ObjectMapperBuilder indentOutput(boolean indentOutput)
```
    Shortcut for SerializationFeature#INDENT_OUTPUT option.
  - featuresToEnable
```
public Jackson2ObjectMapperBuilder featuresToEnable(java.lang.Object... featuresToEnable)
```
    Specify features to enable.
    
    See Also:
    
    com.fasterxml.jackson.core.JsonParser.Feature, com.fasterxml.jackson.core.JsonGenerator.Feature, com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, com.fasterxml.jackson.databind.MapperFeature
  - featuresToDisable
```
public Jackson2ObjectMapperBuilder featuresToDisable(java.lang.Object... featuresToDisable)
```
    Specify features to disable.
    
    See Also:
    
    com.fasterxml.jackson.core.JsonParser.Feature, com.fasterxml.jackson.core.JsonGenerator.Feature, com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, com.fasterxml.jackson.databind.MapperFeature
  - modules
```
public Jackson2ObjectMapperBuilder modules(Module... modules)
```
    Specify one or more modules to be registered with the ObjectMapper.
    Note: If this is set, no finding of modules is going to happen - not by Jackson, and not by Spring either (see findModulesViaServiceLoader). As a consequence, specifying an empty list here will suppress any kind of module detection.
    Specify either this or modulesToInstall(Module...), not both.
    
    Since:
    
    4.1.5
    
    See Also:
    
    modules(List), com.fasterxml.jackson.databind.Module
  - modules
```
public Jackson2ObjectMapperBuilder modules(java.util.List<Module> modules)
```
    Set a complete list of modules to be registered with the ObjectMapper.
    Note: If this is set, no finding of modules is going to happen - not by Jackson, and not by Spring either (see findModulesViaServiceLoader). As a consequence, specifying an empty list here will suppress any kind of module detection.
    Specify either this or modulesToInstall(Module...), not both.
    
    See Also:
    
    modules(Module...), com.fasterxml.jackson.databind.Module
  - modulesToInstall
```
public Jackson2ObjectMapperBuilder modulesToInstall(Module... modules)
```
    Specify one or more modules to be registered with the ObjectMapper.
    Modules specified here will be registered after Spring's autodetection of JSR-310 and Joda-Time, or Jackson's finding of modules (see findModulesViaServiceLoader), allowing to eventually override their configuration.
    Specify either this or modules, not both.
    
    Since:
    
    4.1.5
    
    See Also:
    
    com.fasterxml.jackson.databind.Module
  - findModulesViaServiceLoader
```
public Jackson2ObjectMapperBuilder findModulesViaServiceLoader(boolean findModules)
```
    Set whether to let Jackson find available modules via the JDK ServiceLoader, based on META-INF metadata in the classpath. Requires Jackson 2.2 or higher.
    If this mode is not set, Spring's Jackson2ObjectMapperBuilder itself will try to find the JSR-310 and Joda-Time support modules on the classpath - provided that Java 8 and Joda-Time themselves are available, respectively.
    
    See Also:
    
    com.fasterxml.jackson.databind.ObjectMapper#findModules()
  - moduleClassLoader
```
public Jackson2ObjectMapperBuilder moduleClassLoader(java.lang.ClassLoader moduleClassLoader)
```
    Set the ClassLoader to use for loading Jackson extension modules.
  - handlerInstantiator
```
public Jackson2ObjectMapperBuilder handlerInstantiator(HandlerInstantiator handlerInstantiator)
```
    Customize the construction of Jackson handlers (JsonSerializer, JsonDeserializer, KeyDeserializer, TypeResolverBuilder and TypeIdResolver).
    
    Since:
    
    4.1.3
    
    See Also:
    
    applicationContext(ApplicationContext)
  - applicationContext
```
public Jackson2ObjectMapperBuilder applicationContext(ApplicationContext applicationContext)
```
    Set the Spring ApplicationContext in order to autowire Jackson handlers (JsonSerializer, JsonDeserializer, KeyDeserializer, TypeResolverBuilder and TypeIdResolver).
    
    Since:
    
    4.1.3
    
    See Also:
    
    SpringHandlerInstantiator
  - build
```
public <T extends ObjectMapper> T build()
```
    Build a new ObjectMapper instance.
    Each build operation produces an independent ObjectMapper instance. The builder's settings can get modified, with a subsequent build operation then producing a new ObjectMapper based on the most recent settings.
    
    Returns:
    
    the newly built ObjectMapper
  - configure
```
public void configure(ObjectMapper objectMapper)
```
    Configure an existing ObjectMapper instance with this builder's settings. This can be applied to any number of ObjectMappers.
    
    Parameters:
    
    objectMapper - the ObjectMapper to configure
  - customizeDefaultFeatures
```
private void customizeDefaultFeatures(ObjectMapper objectMapper)
```
  - addSerializers
```
private <T> void addSerializers(SimpleModule module)
```
  - addDeserializers
```
private <T> void addDeserializers(SimpleModule module)
```
  - configureFeature
```
private void configureFeature(ObjectMapper objectMapper,
                              java.lang.Object feature,
                              boolean enabled)
```
  - registerWellKnownModulesIfAvailable
```
private void registerWellKnownModulesIfAvailable(ObjectMapper objectMapper)
```
  - json
```
public static Jackson2ObjectMapperBuilder json()
```
    Obtain a Jackson2ObjectMapperBuilder instance in order to build a regular JSON ObjectMapper instance.
  - xml
```
public static Jackson2ObjectMapperBuilder xml()
```
    Obtain a Jackson2ObjectMapperBuilder instance in order to build an XmlMapper instance.

Class Jackson2ObjectMapperBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

createXmlMapper

dateFormat

locale

timeZone

annotationIntrospector

propertyNamingStrategy

serializationInclusion

filters

mixIns

serializers

deserializers

features

modules

moduleClasses

findModulesViaServiceLoader

findWellKnownModules

moduleClassLoader

handlerInstantiator

applicationContext

Constructor Detail

Jackson2ObjectMapperBuilder

Method Detail

createXmlMapper

dateFormat

simpleDateFormat

locale

locale

timeZone

timeZone

annotationIntrospector

propertyNamingStrategy

serializationInclusion

filters

mixIn

mixIns

serializers

serializerByType

serializersByType

deserializerByType

deserializersByType

autoDetectFields

autoDetectGettersSetters

defaultViewInclusion

failOnUnknownProperties

failOnEmptyBeans

indentOutput

featuresToEnable

featuresToDisable

modules

modules

modulesToInstall

findModulesViaServiceLoader

moduleClassLoader

handlerInstantiator

applicationContext

build

configure

customizeDefaultFeatures

addSerializers

addDeserializers

configureFeature

registerWellKnownModulesIfAvailable

json

xml