Uses of Class
tools.jackson.databind.SerializationConfig
Packages that use SerializationConfig
Package
Description
Basic data binding (mapping) functionality that
allows for reading JSON content into Java Objects (POJOs)
and JSON Trees (
JsonNode
), as well as
writing Java Objects and trees as JSON.Package that contains most of configuration-related classes;
exception being couple of most-commonly used configuration
things (like Feature enumerations) that are at the
main level (
tools.jackson.databind
).Contains extended support for "external" packages: things that
may or may not be present in runtime environment, but that are
commonly enough used so that explicit support can be added.
Package that contains handlers specific to SQL datatypes.
Package that contains classes and interfaces to help implement
custom extension
JacksonModule
s
(which are registered on ObjectMapper via builders}.Contains implementation classes of serialization part of
data binding.
Utility classes for Mapper package.
-
Uses of SerializationConfig in tools.jackson.databind
Fields in tools.jackson.databind declared as SerializationConfigModifier and TypeFieldDescriptionprotected final SerializationConfig
ObjectWriter._config
General serialization configuration settingsprotected final SerializationConfig
SequenceWriter._config
protected final SerializationConfig
SerializationContext._config
Serialization configuration to use for serialization processing.protected final SerializationConfig
ObjectMapper._serializationConfig
Configuration object that defines basic global settings for the serialization processMethods in tools.jackson.databind that return SerializationConfigModifier and TypeMethodDescriptionprotected final SerializationConfig
SerializationConfig._with
(DatatypeFeatures dtFeatures) protected final SerializationConfig
SerializationConfig._withBase
(BaseSettings newBase) ObjectWriter.getConfig()
final SerializationConfig
SerializationContext.getConfig()
Method for accessing configuration for the serialization processing.ObjectMapper.serializationConfig()
Accessor for internal configuration object that contains settings for serialization operations (writeValue(...)
methods)
NOTE: Not to be used by application code; needed by some testsSerializationConfig.with
(DateFormat df) In addition to constructing instance with specified date format, will enable or disableSerializationFeature.WRITE_DATES_AS_TIMESTAMPS
(enable if format set as null; disable if non-null)SerializationConfig.with
(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.SerializationConfig.with
(StreamWriteFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.SerializationConfig.with
(ContextAttributes attrs) SerializationConfig.with
(SerializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.SerializationConfig.with
(SerializationFeature first, SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.SerializationConfig.withDefaultPrettyPrinter
(PrettyPrinter pp) SerializationConfig.withFeatures
(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.SerializationConfig.withFeatures
(StreamWriteFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.SerializationConfig.withFeatures
(SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.SerializationConfig.withFilters
(FilterProvider filterProvider) SerializationConfig.without
(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.SerializationConfig.without
(StreamWriteFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.SerializationConfig.without
(SerializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.SerializationConfig.without
(SerializationFeature first, SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.SerializationConfig.withoutFeatures
(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.SerializationConfig.withoutFeatures
(StreamWriteFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.SerializationConfig.withoutFeatures
(SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.SerializationConfig.withRootName
(PropertyName rootName) Methods in tools.jackson.databind with parameters of type SerializationConfigModifier and TypeMethodDescriptionprotected ObjectWriter
ObjectWriter._new
(ObjectWriter base, SerializationConfig config) Overridable factory method called by various "withXxx()" methodsprotected ObjectWriter
ObjectMapper._newWriter
(SerializationConfig config) Factory method sub-classes must override, to produceObjectWriter
instances of proper sub-typeprotected ObjectWriter
ObjectMapper._newWriter
(SerializationConfig config, FormatSchema schema) Factory method sub-classes must override, to produceObjectWriter
instances of proper sub-typeprotected ObjectWriter
ObjectMapper._newWriter
(SerializationConfig config, JavaType rootType, PrettyPrinter pp) Factory method sub-classes must override, to produceObjectWriter
instances of proper sub-typeprotected SerializationContextExt
ObjectMapper._serializationContext
(SerializationConfig config) Overridable helper method used for constructingSerializationContext
to use for serialization.protected final void
ObjectMapper._writeCloseableValue
(JsonGenerator g, Object value, SerializationConfig cfg) Helper method used when value to serialize isCloseable
and itsclose()
method is to be called right after serialization has been calledValueSerializer.withFormatOverrides
(SerializationConfig config, JsonFormat.Value formatOverrides) Mutant factory called if there is need to create a serializer with specified format overrides (typically from property on which this serializer would be used, based on type declaration).Constructors in tools.jackson.databind with parameters of type SerializationConfigModifierConstructorDescriptionprotected
ObjectWriter
(ObjectMapper mapper, SerializationConfig config) Alternative constructor for initial instantiation byObjectMapper
protected
ObjectWriter
(ObjectMapper mapper, SerializationConfig config, FormatSchema s) Alternative constructor for initial instantiation byObjectMapper
protected
ObjectWriter
(ObjectMapper mapper, SerializationConfig config, JavaType rootType, PrettyPrinter pp) Constructor used byObjectMapper
for initial instantiationprotected
ObjectWriter
(ObjectWriter base, SerializationConfig config) Copy constructor used for building variations.protected
ObjectWriter
(ObjectWriter base, SerializationConfig config, GeneratorSettings genSettings, ObjectWriter.Prefetch prefetch) Copy constructor used for building variations.protected
SerializationConfig
(SerializationConfig src, PrettyPrinter defaultPP) protected
SerializationConfig
(SerializationConfig src, ContextAttributes attrs) protected
SerializationConfig
(SerializationConfig src, DatatypeFeatures dtFeatures) protected
SerializationContext
(TokenStreamFactory streamFactory, SerializationConfig config, GeneratorSettings generatorConfig, SerializerFactory f, SerializerCache cache) -
Uses of SerializationConfig in tools.jackson.databind.cfg
Methods in tools.jackson.databind.cfg that return SerializationConfigModifier and TypeMethodDescriptionMapperBuilder.buildSerializationConfig
(ConfigOverrides configOverrides, MixInHandler mixins, TypeFactory tf, ClassIntrospector classIntr, SubtypeResolver str, RootNameLookup rootNames, FilterProvider filterProvider) Methods in tools.jackson.databind.cfg with parameters of type SerializationConfigModifier and TypeMethodDescriptionabstract SerializationContextExt
SerializationContexts.createContext
(SerializationConfig config, GeneratorSettings genSettings) Factory method for constructing context object for individualwriteValue()
calls.SerializationContexts.DefaultImpl.createContext
(SerializationConfig config, GeneratorSettings genSettings) SerializationContexts.forMapper
(Object mapper, SerializationConfig config, TokenStreamFactory tsf, SerializerFactory serializerFactory) Mutant factory method called when instance is actually created for use by mapper (as opposed to coming into existence during building, module registration).CacheProvider.forSerializerCache
(SerializationConfig config) Method to provide aLookupCache
instance for constructingSerializerCache
.DefaultCacheProvider.forSerializerCache
(SerializationConfig config) HandlerInstantiator.includeFilterInstance
(SerializationConfig config, BeanPropertyDefinition forProperty, Class<?> filterClass) Method called to construct a Filter (any Object with implementation ofequals(Object)
that determines if given value is to be excluded (true) or included (false)) to be used based onJsonInclude
annotation (or equivalent).abstract ValueSerializer<?>
HandlerInstantiator.serializerInstance
(SerializationConfig config, Annotated annotated, Class<?> serClass) Method called to get an instance of serializer of specified type. -
Uses of SerializationConfig in tools.jackson.databind.ext
Methods in tools.jackson.databind.ext with parameters of type SerializationConfigModifier and TypeMethodDescriptionOptionalHandlerFactory.findSerializer
(SerializationConfig config, JavaType type) -
Uses of SerializationConfig in tools.jackson.databind.ext.sql
Methods in tools.jackson.databind.ext.sql with parameters of type SerializationConfigModifier and TypeMethodDescriptionJavaSqlTypeHandlerFactory.findSerializer
(SerializationConfig config, JavaType type) -
Uses of SerializationConfig in tools.jackson.databind.module
Methods in tools.jackson.databind.module with parameters of type SerializationConfigModifier and TypeMethodDescriptionSimpleSerializers.findArraySerializer
(SerializationConfig config, ArrayType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) SimpleSerializers.findCollectionLikeSerializer
(SerializationConfig config, CollectionLikeType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) SimpleSerializers.findCollectionSerializer
(SerializationConfig config, CollectionType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) SimpleSerializers.findMapLikeSerializer
(SerializationConfig config, MapLikeType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, ValueSerializer<Object> keySerializer, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) SimpleSerializers.findMapSerializer
(SerializationConfig config, MapType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, ValueSerializer<Object> keySerializer, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) SimpleSerializers.findSerializer
(SerializationConfig config, JavaType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides) -
Uses of SerializationConfig in tools.jackson.databind.ser
Fields in tools.jackson.databind.ser declared as SerializationConfigModifier and TypeFieldDescriptionprotected final SerializationConfig
BeanSerializerBuilder._config
protected final SerializationConfig
PropertyBuilder._config
Methods in tools.jackson.databind.ser with parameters of type SerializationConfigModifier and TypeMethodDescriptionValueSerializerModifier.changeProperties
(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) Method called byBeanSerializerFactory
with tentative set of discovered properties.protected BeanSerializerBuilder
BeanSerializerFactory.constructBeanSerializerBuilder
(SerializationConfig config, BeanDescription beanDesc) protected PropertyBuilder
BeanSerializerFactory.constructPropertyBuilder
(SerializationConfig config, BeanDescription beanDesc) protected List<BeanPropertyWriter>
BeanSerializerFactory.filterBeanProperties
(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> props) Overridable method that can filter out properties.protected List<BeanPropertyWriter>
BeanSerializerFactory.filterUnwantedJDKProperties
(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> props) Overridable method used to filter out specifically problematic JDK provided properties.Serializers.Base.findArraySerializer
(SerializationConfig config, ArrayType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) default ValueSerializer<?>
Serializers.findArraySerializer
(SerializationConfig config, ArrayType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) Method called by serialization framework first time a serializer is needed for specified array type.Serializers.Base.findCollectionLikeSerializer
(SerializationConfig config, CollectionLikeType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) default ValueSerializer<?>
Serializers.findCollectionLikeSerializer
(SerializationConfig config, CollectionLikeType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) Method called by serialization framework first time a serializer is needed for specified "Collection-like" type (type that acts likeCollection
, but does not implement it).Serializers.Base.findCollectionSerializer
(SerializationConfig config, CollectionType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) default ValueSerializer<?>
Serializers.findCollectionSerializer
(SerializationConfig config, CollectionType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) Method called by serialization framework first time a serializer is needed for specifiedCollection
type.Serializers.Base.findExplicitPOJOSerializer
(SerializationConfig config, JavaType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides) default ValueSerializer<?>
Serializers.findExplicitPOJOSerializer
(SerializationConfig config, JavaType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides) Method called in case that a given type or property is declared to use shapeJsonFormat.Shape.POJO
and is expected to be serialized "as POJO", that is, as an (JSON) Object.protected Object
BasicSerializerFactory.findFilterId
(SerializationConfig config, BeanDescription beanDesc) Method called to find filter that is configured to be used with bean serializer being built, if any.Serializers.Base.findMapLikeSerializer
(SerializationConfig config, MapLikeType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, ValueSerializer<Object> keySerializer, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) default ValueSerializer<?>
Serializers.findMapLikeSerializer
(SerializationConfig config, MapLikeType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, ValueSerializer<Object> keySerializer, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) Method called by serialization framework first time a serializer is needed for specified "Map-like" type (type that acts likeMap
, but does not implement it).Serializers.Base.findMapSerializer
(SerializationConfig config, MapType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, ValueSerializer<Object> keySerializer, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) default ValueSerializer<?>
Serializers.findMapSerializer
(SerializationConfig config, MapType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, ValueSerializer<Object> keySerializer, TypeSerializer elementTypeSerializer, ValueSerializer<Object> elementValueSerializer) Method called by serialization framework first time a serializer is needed for specifiedMap
type.Serializers.Base.findReferenceSerializer
(SerializationConfig config, ReferenceType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer contentTypeSerializer, ValueSerializer<Object> contentValueSerializer) default ValueSerializer<?>
Serializers.findReferenceSerializer
(SerializationConfig config, ReferenceType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides, TypeSerializer contentTypeSerializer, ValueSerializer<Object> contentValueSerializer) Method called by serialization framework first time a serializer is needed for givenReferenceType
Serializers.Base.findSerializer
(SerializationConfig config, JavaType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides) default ValueSerializer<?>
Serializers.findSerializer
(SerializationConfig config, JavaType type, BeanDescription beanDesc, JsonFormat.Value formatOverrides) Method called by serialization framework first time a serializer is needed for specified type, which is not of a container or reference type (for which other methods are called).protected final ValueSerializer<?>
BasicSerializerFactory.findSerializerByLookup
(JavaType type, SerializationConfig config, BeanDescription beanDesc, JsonFormat.Value format, boolean staticTyping) Method that will use fast lookup (and identity comparison) methods to see if we know serializer to use for given type.void
AnyGetterWriter.fixAccess
(SerializationConfig config) void
BeanPropertyWriter.fixAccess
(SerializationConfig config) Method called to ensure that the mutator has proper access rights to be called, as per configuration.ValueSerializerModifier.modifyArraySerializer
(SerializationConfig config, ArrayType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) Method called byDeserializerFactory
after it has constructed the standard serializer for givenArrayType
to make it possible to either replace or augment this serializer with additional functionality.ValueSerializerModifier.modifyCollectionLikeSerializer
(SerializationConfig config, CollectionLikeType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) ValueSerializerModifier.modifyCollectionSerializer
(SerializationConfig config, CollectionType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) ValueSerializerModifier.modifyEnumSerializer
(SerializationConfig config, JavaType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) ValueSerializerModifier.modifyKeySerializer
(SerializationConfig config, JavaType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) Method called byDeserializerFactory
after it has constructed the default key serializer to use for serializingMap
keys of given type.ValueSerializerModifier.modifyMapLikeSerializer
(SerializationConfig config, MapLikeType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) ValueSerializerModifier.modifyMapSerializer
(SerializationConfig config, MapType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer) ValueSerializerModifier.modifySerializer
(SerializationConfig config, BeanDescription beanDesc, ValueSerializer<?> serializer) Method called byBeanSerializerFactory
after constructing default bean serializer instance with properties collected and ordered earlier.ValueSerializerModifier.orderProperties
(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) Method called byBeanSerializerFactory
with set of properties to serialize, in default ordering (based on defaults as well as possible type annotations).protected void
BeanSerializerFactory.processViews
(SerializationConfig config, BeanSerializerBuilder builder) Method called to handle view information for constructed serializer, based on bean property writers.protected void
BeanSerializerFactory.removeSetterlessGetters
(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyDefinition> properties) Helper method that will remove all properties that do not have a mutator.ValueSerializerModifier.updateBuilder
(SerializationConfig config, BeanDescription beanDesc, BeanSerializerBuilder builder) Method called byBeanSerializerFactory
after collecting all information regarding POJO to serialize and updating builder with it, but before constructing serializer.protected boolean
BasicSerializerFactory.usesStaticTyping
(SerializationConfig config, BeanDescription beanDesc) Helper method to check whether global settings and/or class annotations for the bean class indicate that static typing (declared types) should be used for properties.Constructors in tools.jackson.databind.ser with parameters of type SerializationConfigModifierConstructorDescriptionBeanSerializerBuilder
(SerializationConfig config, BeanDescription beanDesc) Impl
(TokenStreamFactory streamFactory, SerializationConfig config, GeneratorSettings genSettings, SerializerFactory f, SerializerCache cache) PropertyBuilder
(SerializationConfig config, BeanDescription beanDesc) protected
SerializationContextExt
(TokenStreamFactory streamFactory, SerializationConfig config, GeneratorSettings genSettings, SerializerFactory f, SerializerCache cache) -
Uses of SerializationConfig in tools.jackson.databind.ser.jackson
Methods in tools.jackson.databind.ser.jackson with parameters of type SerializationConfigModifier and TypeMethodDescriptionstatic JsonValueSerializer
JsonValueSerializer.construct
(SerializationConfig config, JavaType nominalType, JavaType valueType, boolean staticTyping, TypeSerializer vts, ValueSerializer<?> ser, AnnotatedMember accessor) -
Uses of SerializationConfig in tools.jackson.databind.ser.jdk
Methods in tools.jackson.databind.ser.jdk with parameters of type SerializationConfigModifier and TypeMethodDescriptionstatic EnumSerializer
EnumSerializer.construct
(Class<?> enumClass, SerializationConfig config, BeanDescription beanDesc, JsonFormat.Value format) Factory method used byBasicSerializerFactory
for constructing serializer instance of Enum types.protected static EnumValues
EnumSerializer.constructEnumNamingStrategyValues
(SerializationConfig config, Class<Enum<?>> enumClass, AnnotatedClass annotatedClass) Factory method used to resolve an instance ofEnumValues
withEnumNamingStrategy
applied for the target class.static ValueSerializer<Object>
JDKKeySerializers.getFallbackKeySerializer
(SerializationConfig config, Class<?> rawKeyType, AnnotatedClass annotatedClass) Method called if no specified key serializer was located; will return a "default" key serializer initialized byJDKKeySerializers.EnumKeySerializer.construct(Class, EnumValues, EnumValues)
static ValueSerializer<Object>
JDKKeySerializers.getStdKeySerializer
(SerializationConfig config, Class<?> rawKeyType, boolean useDefault) -
Uses of SerializationConfig in tools.jackson.databind.util
Methods in tools.jackson.databind.util with parameters of type SerializationConfigModifier and TypeMethodDescriptionstatic EnumValues
EnumValues.construct
(SerializationConfig config, AnnotatedClass enumClass) NOTE: do NOT call this if configuration may change, and choice between toString() and name() might change dynamically.