Class MapperBuilder<M extends ObjectMapper,B extends MapperBuilder<M,B>>
- java.lang.Object
-
- com.fasterxml.jackson.databind.cfg.MapperBuilder<M,B>
-
- Direct Known Subclasses:
JsonMapper.Builder
public abstract class MapperBuilder<M extends ObjectMapper,B extends MapperBuilder<M,B>> extends Object
Jackson 3 will introduce fully immutable, builder-based system for constructingObjectMappers. Same can not be done with 2.10 for backwards-compatibility reasons; but we can offer sort of "fake" builder, which simply encapsulates configuration calls. The main (and only) point is to allow gradual upgrade.- Since:
- 2.10
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMapperBuilder(M mapper)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected B_this()BactivateDefaultTyping(PolymorphicTypeValidator subtypeValidator)Convenience method that is equivalent to callingBactivateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping dti)Convenience method that is equivalent to callingBactivateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, com.fasterxml.jackson.annotation.JsonTypeInfo.As includeAs)Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated withJsonTypeInfo).BactivateDefaultTypingAsProperty(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 withJsonTypeInfo) -- 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)BaddHandler(DeserializationProblemHandler h)Method used for adding aDeserializationProblemHandlerfor this builder, at the head of the list (meaning it has priority over handler registered earlier).BaddMixIn(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.BaddModule(Module module)BaddModules(Module... modules)BaddModules(Iterable<? extends Module> modules)BannotationIntrospector(AnnotationIntrospector intr)Method for replacingAnnotationIntrospectorused by the mapper instance to be built.Mbuild()Method to call to create actual mapper instance.BclearProblemHandlers()Method that may be used to remove allDeserializationProblemHandlers added to this builder (if any).Bconfigure(com.fasterxml.jackson.core.JsonGenerator.Feature feature, boolean state)Bconfigure(com.fasterxml.jackson.core.JsonParser.Feature feature, boolean state)Bconfigure(com.fasterxml.jackson.core.StreamReadFeature feature, boolean state)Bconfigure(com.fasterxml.jackson.core.StreamWriteFeature feature, boolean state)Bconfigure(DeserializationFeature feature, boolean state)Bconfigure(MapperFeature feature, boolean state)Bconfigure(SerializationFeature feature, boolean state)BdeactivateDefaultTyping()Method for disabling automatic inclusion of type information; if so, only explicitly annotated types (ones withJsonTypeInfo) will have additional embedded type information.BdefaultBase64Variant(com.fasterxml.jackson.core.Base64Variant v)Method that will configure defaultBase64Variantthatbyte[]serializers and deserializers will use.BdefaultDateFormat(DateFormat df)Method for configuring the defaultDateFormatto use when serializing time values as Strings, and deserializing from JSON Strings.BdefaultLeniency(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).BdefaultLocale(Locale locale)Method for overriding default locale to use for formatting.BdefaultMergeable(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).BdefaultPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp)BdefaultPropertyInclusion(com.fasterxml.jackson.annotation.JsonInclude.Value incl)Method for configured default property inclusion to use for serialization.BdefaultSetterInfo(com.fasterxml.jackson.annotation.JsonSetter.Value v)BdefaultTimeZone(TimeZone tz)Method for overriding default TimeZone to use for formatting.Bdisable(com.fasterxml.jackson.core.JsonGenerator.Feature... features)Bdisable(com.fasterxml.jackson.core.JsonParser.Feature... features)Bdisable(com.fasterxml.jackson.core.StreamReadFeature... features)Bdisable(com.fasterxml.jackson.core.StreamWriteFeature... features)Bdisable(DeserializationFeature... features)Bdisable(MapperFeature... features)Bdisable(SerializationFeature... features)Benable(com.fasterxml.jackson.core.JsonGenerator.Feature... features)Benable(com.fasterxml.jackson.core.JsonParser.Feature... features)Benable(com.fasterxml.jackson.core.StreamReadFeature... features)Benable(com.fasterxml.jackson.core.StreamWriteFeature... features)Benable(DeserializationFeature... features)Benable(MapperFeature... features)Benable(SerializationFeature... features)BfilterProvider(FilterProvider prov)Method for configuring this mapper to use specifiedFilterProviderfor mapping Filter Ids to actual filter instances.BfindAndAddModules()Convenience method that is functionally equivalent to:addModules(builder.findModules());static List<Module>findModules()Method for locating available methods, using JDKServiceLoaderfacility, along with module-provided SPI.static List<Module>findModules(ClassLoader classLoader)Method for locating available methods, using JDKServiceLoaderfacility, along with module-provided SPI.BhandlerInstantiator(HandlerInstantiator hi)Method for configuringHandlerInstantiatorto use for creating instances of handlers (such as serializers, deserializers, type and type id resolvers), given a class.BinjectableValues(InjectableValues v)booleanisEnabled(com.fasterxml.jackson.core.JsonGenerator.Feature f)booleanisEnabled(com.fasterxml.jackson.core.JsonParser.Feature f)booleanisEnabled(DeserializationFeature f)booleanisEnabled(MapperFeature f)booleanisEnabled(SerializationFeature f)BnodeFactory(JsonNodeFactory f)BpolymorphicTypeValidator(PolymorphicTypeValidator ptv)Method for assigningPolymorphicTypeValidatorto use for validating subtypes when using Class name - based polymorphic deserialization using annotations (validator used with "Default Typing" is specified by passing inactivateDefaultTyping(PolymorphicTypeValidator)instead).BpropertyNamingStrategy(PropertyNamingStrategy s)BregisterSubtypes(NamedType... subtypes)BregisterSubtypes(Class<?>... subtypes)BregisterSubtypes(Collection<Class<?>> subtypes)BserializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include incl)Method for configured default property inclusion to use for serialization.BserializerFactory(SerializerFactory f)com.fasterxml.jackson.core.TokenStreamFactorystreamFactory()BsubtypeResolver(SubtypeResolver r)BtypeFactory(TypeFactory f)Bvisibility(com.fasterxml.jackson.annotation.PropertyAccessor forMethod, com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility visibility)Bvisibility(VisibilityChecker<?> vc)
-
-
-
Field Detail
-
_mapper
protected final M extends ObjectMapper _mapper
-
-
Constructor Detail
-
MapperBuilder
protected MapperBuilder(M mapper)
-
-
Method Detail
-
build
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.
-
isEnabled
public boolean isEnabled(MapperFeature f)
-
isEnabled
public boolean isEnabled(DeserializationFeature f)
-
isEnabled
public boolean isEnabled(SerializationFeature f)
-
isEnabled
public boolean isEnabled(com.fasterxml.jackson.core.JsonParser.Feature f)
-
isEnabled
public boolean isEnabled(com.fasterxml.jackson.core.JsonGenerator.Feature f)
-
streamFactory
public com.fasterxml.jackson.core.TokenStreamFactory streamFactory()
-
enable
public B enable(MapperFeature... features)
-
disable
public B disable(MapperFeature... features)
-
configure
public B configure(MapperFeature feature, boolean state)
-
enable
public B enable(SerializationFeature... features)
-
disable
public B disable(SerializationFeature... features)
-
configure
public B configure(SerializationFeature feature, boolean state)
-
enable
public B enable(DeserializationFeature... features)
-
disable
public B disable(DeserializationFeature... features)
-
configure
public B configure(DeserializationFeature feature, boolean state)
-
enable
public B enable(com.fasterxml.jackson.core.JsonParser.Feature... features)
-
disable
public B disable(com.fasterxml.jackson.core.JsonParser.Feature... features)
-
configure
public B configure(com.fasterxml.jackson.core.JsonParser.Feature feature, boolean state)
-
enable
public B enable(com.fasterxml.jackson.core.JsonGenerator.Feature... features)
-
disable
public B disable(com.fasterxml.jackson.core.JsonGenerator.Feature... features)
-
configure
public B configure(com.fasterxml.jackson.core.JsonGenerator.Feature feature, boolean state)
-
enable
public B enable(com.fasterxml.jackson.core.StreamReadFeature... features)
-
disable
public B disable(com.fasterxml.jackson.core.StreamReadFeature... features)
-
configure
public B configure(com.fasterxml.jackson.core.StreamReadFeature feature, boolean state)
-
enable
public B enable(com.fasterxml.jackson.core.StreamWriteFeature... features)
-
disable
public B disable(com.fasterxml.jackson.core.StreamWriteFeature... features)
-
configure
public B configure(com.fasterxml.jackson.core.StreamWriteFeature feature, boolean state)
-
findModules
public static List<Module> findModules()
Method for locating available methods, using JDKServiceLoaderfacility, along with module-provided SPI.Note that method does not do any caching, so calls should be considered potentially expensive.
-
findModules
public static List<Module> findModules(ClassLoader classLoader)
Method for locating available methods, using JDKServiceLoaderfacility, along with module-provided SPI.Note that method does not do any caching, so calls should be considered potentially expensive.
-
findAndAddModules
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.
-
annotationIntrospector
public B annotationIntrospector(AnnotationIntrospector intr)
Method for replacingAnnotationIntrospectorused 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 atAnnotationIntrospectorPair.- See Also:
AnnotationIntrospectorPair
-
nodeFactory
public B nodeFactory(JsonNodeFactory f)
-
typeFactory
public B typeFactory(TypeFactory f)
-
subtypeResolver
public B subtypeResolver(SubtypeResolver r)
-
visibility
public B visibility(VisibilityChecker<?> vc)
-
visibility
public B visibility(com.fasterxml.jackson.annotation.PropertyAccessor forMethod, com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility visibility)
-
handlerInstantiator
public B handlerInstantiator(HandlerInstantiator hi)
Method for configuringHandlerInstantiatorto use for creating instances of handlers (such as serializers, deserializers, type and type id resolvers), given a class.- Parameters:
hi- Instantiator to use; if null, use the default implementation
-
propertyNamingStrategy
public B propertyNamingStrategy(PropertyNamingStrategy s)
-
serializerFactory
public B serializerFactory(SerializerFactory f)
-
filterProvider
public B filterProvider(FilterProvider prov)
Method for configuring this mapper to use specifiedFilterProviderfor 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 notObjectWriters.
-
defaultPrettyPrinter
public B defaultPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp)
-
injectableValues
public B injectableValues(InjectableValues v)
-
addHandler
public B addHandler(DeserializationProblemHandler h)
Method used for adding aDeserializationProblemHandlerfor this builder, at the head of the list (meaning it has priority over handler registered earlier).
-
clearProblemHandlers
public B clearProblemHandlers()
Method that may be used to remove allDeserializationProblemHandlers added to this builder (if any).
-
defaultSetterInfo
public B defaultSetterInfo(com.fasterxml.jackson.annotation.JsonSetter.Value v)
-
defaultMergeable
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).
-
defaultLeniency
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).
-
defaultDateFormat
public B defaultDateFormat(DateFormat df)
Method for configuring the defaultDateFormatto use when serializing time values as Strings, and deserializing from JSON Strings. If you need per-request configuration, factory methods inObjectReaderandObjectWriterinstead.
-
defaultTimeZone
public B defaultTimeZone(TimeZone tz)
Method for overriding default TimeZone to use for formatting. Default value used is UTC (NOT default TimeZone of JVM).
-
defaultLocale
public B defaultLocale(Locale locale)
Method for overriding default locale to use for formatting. Default value used isLocale.getDefault().
-
defaultBase64Variant
public B defaultBase64Variant(com.fasterxml.jackson.core.Base64Variant v)
Method that will configure defaultBase64Variantthatbyte[]serializers and deserializers will use.- Parameters:
v- Base64 variant to use- Returns:
- This builder instance to allow call chaining
-
serializationInclusion
public B serializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include incl)
Method for configured default property inclusion to use for serialization.- Parameters:
incl- Default property inclusion to set- Returns:
- This builder instance to allow call chaining
-
defaultPropertyInclusion
public B defaultPropertyInclusion(com.fasterxml.jackson.annotation.JsonInclude.Value incl)
Method for configured default property inclusion to use for serialization.- Parameters:
incl- Default property inclusion to set- Returns:
- This builder instance to allow call chaining
- Since:
- 2.11
-
addMixIn
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
mixinSourceofnull
-
registerSubtypes
public B registerSubtypes(Collection<Class<?>> subtypes)
-
polymorphicTypeValidator
public B polymorphicTypeValidator(PolymorphicTypeValidator ptv)
Method for assigningPolymorphicTypeValidatorto use for validating subtypes when using Class name - based polymorphic deserialization using annotations (validator used with "Default Typing" is specified by passing inactivateDefaultTyping(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
-
activateDefaultTyping
public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator)
Convenience method that is equivalent to callingactivateDefaultTyping(subtypeValidator, DefaultTyping.OBJECT_AND_NON_CONCRETE);
NOTE: choice of
PolymorphicTypeValidatorto pass is critical for security as allowing all subtypes can be risky for untrusted content.
-
activateDefaultTyping
public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping dti)
Convenience method that is equivalent to callingactivateDefaultTyping(subtypeValidator, dti, JsonTypeInfo.As.WRAPPER_ARRAY);
NOTE: choice of
PolymorphicTypeValidatorto pass is critical for security as allowing all subtypes can be risky for untrusted content.
-
activateDefaultTyping
public B activateDefaultTyping(PolymorphicTypeValidator subtypeValidator, ObjectMapper.DefaultTyping applicability, com.fasterxml.jackson.annotation.JsonTypeInfo.As includeAs)
Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated withJsonTypeInfo).NOTE: use of
JsonTypeInfo.As#EXTERNAL_PROPERTYNOT SUPPORTED; and attempts of do so will throw anIllegalArgumentExceptionto make this limitation explicit.NOTE: choice of
PolymorphicTypeValidatorto pass is critical for security as allowing all subtypes can be risky for untrusted content.- Parameters:
applicability- Defines kinds of types for which additional type information is added; seeObjectMapper.DefaultTypingfor more information.
-
activateDefaultTypingAsProperty
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 withJsonTypeInfo) -- 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
PolymorphicTypeValidatorto pass is critical for security as allowing all subtypes can be risky for untrusted content.
-
deactivateDefaultTyping
public B deactivateDefaultTyping()
Method for disabling automatic inclusion of type information; if so, only explicitly annotated types (ones withJsonTypeInfo) will have additional embedded type information.
-
_this
protected final B _this()
-
-