Package | Description |
---|---|
com.fasterxml.jackson.databind |
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. |
com.fasterxml.jackson.databind.cfg |
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 (
com.fasterxml.jackson.databind ). |
com.fasterxml.jackson.databind.ext |
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.
|
com.fasterxml.jackson.databind.introspect |
Functionality needed for Bean introspection, required for detecting
accessors and mutators for Beans, as well as locating and handling
method annotations.
|
com.fasterxml.jackson.databind.jsontype |
Package that contains interfaces that define how to implement
functionality for dynamically resolving type during deserialization.
|
com.fasterxml.jackson.databind.jsontype.impl |
Package that contains standard implementations for
TypeResolverBuilder
and
TypeIdResolver . |
com.fasterxml.jackson.databind.module |
Package that contains classes and interfaces to help implement
custom extension
Module s
(which are registered using
ObjectMapper.registerModule(com.fasterxml.jackson.databind.Module) . |
com.fasterxml.jackson.databind.ser |
Contains implementation classes of serialization part of
data binding.
|
com.fasterxml.jackson.databind.ser.std | |
com.fasterxml.jackson.databind.util |
Utility classes for Mapper package.
|
Modifier and Type | Field and Description |
---|---|
protected SerializationConfig |
ObjectWriter._config
General serialization configuration settings
|
protected SerializationConfig |
SequenceWriter._config |
protected SerializationConfig |
SerializerProvider._config
Serialization configuration to use for serialization processing.
|
protected SerializationConfig |
ObjectMapper._serializationConfig
Configuration object that defines basic global
settings for the serialization process
|
Modifier and Type | Method and Description |
---|---|
protected SerializationConfig |
SerializationConfig._with(DatatypeFeatures dtFeatures) |
protected SerializationConfig |
SerializationConfig._withBase(BaseSettings newBase) |
protected SerializationConfig |
SerializationConfig._withMapperFeatures(long mapperFeatures) |
SerializationConfig |
ObjectWriter.getConfig() |
SerializationConfig |
SerializerProvider.getConfig()
Method for accessing configuration for the serialization processing.
|
SerializationConfig |
ObjectMapper.getSerializationConfig()
Method that returns the shared default
SerializationConfig
object that defines configuration settings for serialization. |
SerializationConfig |
SerializationConfig.with(ContextAttributes attrs) |
SerializationConfig |
SerializationConfig.with(DateFormat df)
In addition to constructing instance with specified date format,
will enable or disable
SerializationFeature.WRITE_DATES_AS_TIMESTAMPS
(enable if format set as null; disable if non-null) |
SerializationConfig |
SerializationConfig.with(com.fasterxml.jackson.core.FormatFeature feature)
Fluent factory method that will construct and return a new configuration
object instance with specified feature enabled.
|
SerializationConfig |
SerializationConfig.with(com.fasterxml.jackson.core.JsonGenerator.Feature feature)
Fluent factory method that will construct and return a new configuration
object instance with specified feature enabled.
|
SerializationConfig |
SerializationConfig.with(SerializationFeature feature)
Fluent factory method that will construct and return a new configuration
object instance with specified feature enabled.
|
SerializationConfig |
SerializationConfig.with(SerializationFeature first,
SerializationFeature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features enabled.
|
SerializationConfig |
SerializationConfig.with(SubtypeResolver str) |
SerializationConfig |
SerializationConfig.withDefaultPrettyPrinter(com.fasterxml.jackson.core.PrettyPrinter pp) |
SerializationConfig |
SerializationConfig.withFeatures(com.fasterxml.jackson.core.FormatFeature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features enabled.
|
SerializationConfig |
SerializationConfig.withFeatures(com.fasterxml.jackson.core.JsonGenerator.Feature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features enabled.
|
SerializationConfig |
SerializationConfig.withFeatures(SerializationFeature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features enabled.
|
SerializationConfig |
SerializationConfig.withFilters(FilterProvider filterProvider) |
SerializationConfig |
SerializationConfig.without(com.fasterxml.jackson.core.FormatFeature feature)
Fluent factory method that will construct and return a new configuration
object instance with specified feature disabled.
|
SerializationConfig |
SerializationConfig.without(com.fasterxml.jackson.core.JsonGenerator.Feature feature)
Fluent factory method that will construct and return a new configuration
object instance with specified feature disabled.
|
SerializationConfig |
SerializationConfig.without(SerializationFeature feature)
Fluent factory method that will construct and return a new configuration
object instance with specified feature disabled.
|
SerializationConfig |
SerializationConfig.without(SerializationFeature first,
SerializationFeature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features disabled.
|
SerializationConfig |
SerializationConfig.withoutFeatures(com.fasterxml.jackson.core.FormatFeature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features disabled.
|
SerializationConfig |
SerializationConfig.withoutFeatures(com.fasterxml.jackson.core.JsonGenerator.Feature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features disabled.
|
SerializationConfig |
SerializationConfig.withoutFeatures(SerializationFeature... features)
Fluent factory method that will construct and return a new configuration
object instance with specified features disabled.
|
SerializationConfig |
SerializationConfig.withPropertyInclusion(JsonInclude.Value incl)
Deprecated.
Since 2.9; not needed any more
|
SerializationConfig |
SerializationConfig.withRootName(PropertyName rootName) |
SerializationConfig |
SerializationConfig.withView(Class<?> view) |
Modifier and Type | Method and Description |
---|---|
protected ObjectWriter |
ObjectWriter._new(ObjectWriter base,
SerializationConfig config)
Overridable factory method called by various "withXxx()" methods
|
protected ObjectWriter |
ObjectMapper._newWriter(SerializationConfig config)
Factory method sub-classes must override, to produce
ObjectWriter
instances of proper sub-type |
protected ObjectWriter |
ObjectMapper._newWriter(SerializationConfig config,
com.fasterxml.jackson.core.FormatSchema schema)
Factory method sub-classes must override, to produce
ObjectWriter
instances of proper sub-type |
protected ObjectWriter |
ObjectMapper._newWriter(SerializationConfig config,
JavaType rootType,
com.fasterxml.jackson.core.PrettyPrinter pp)
Factory method sub-classes must override, to produce
ObjectWriter
instances of proper sub-type |
protected DefaultSerializerProvider |
ObjectMapper._serializerProvider(SerializationConfig config)
Overridable helper method used for constructing
SerializerProvider to use for serialization. |
TypeSerializer |
ObjectMapper.DefaultTypeResolverBuilder.buildTypeSerializer(SerializationConfig config,
JavaType baseType,
Collection<NamedType> subtypes) |
ObjectMapper |
ObjectMapper.setConfig(SerializationConfig config)
Method that allows overriding of the underlying
SerializationConfig
object, which contains serialization-specific configuration settings. |
Constructor and Description |
---|
ObjectWriter(ObjectMapper mapper,
SerializationConfig config)
Alternative constructor for initial instantiation by
ObjectMapper |
ObjectWriter(ObjectMapper mapper,
SerializationConfig config,
com.fasterxml.jackson.core.FormatSchema s)
Alternative constructor for initial instantiation by
ObjectMapper |
ObjectWriter(ObjectMapper mapper,
SerializationConfig config,
JavaType rootType,
com.fasterxml.jackson.core.PrettyPrinter pp)
Constructor used by
ObjectMapper for initial instantiation |
ObjectWriter(ObjectWriter base,
SerializationConfig config)
Copy constructor used for building variations.
|
ObjectWriter(ObjectWriter base,
SerializationConfig config,
ObjectWriter.GeneratorSettings genSettings,
ObjectWriter.Prefetch prefetch)
Copy constructor used for building variations.
|
SerializationConfig(SerializationConfig src,
ContextAttributes attrs) |
SerializationConfig(SerializationConfig src,
DatatypeFeatures dtFeatures) |
SerializationConfig(SerializationConfig src,
com.fasterxml.jackson.core.PrettyPrinter defaultPP) |
SerializationConfig(SerializationConfig src,
SimpleMixInResolver mixins) |
SerializationConfig(SerializationConfig src,
SubtypeResolver str,
SimpleMixInResolver mixins,
RootNameLookup rootNames,
ConfigOverrides configOverrides)
Copy-constructor used for making a copy to be used by new
ObjectMapper . |
SerializerProvider(SerializerProvider src,
SerializationConfig config,
SerializerFactory f)
"Copy-constructor", used by sub-classes when creating actual non-blueprint
instances to use.
|
Modifier and Type | Method and Description |
---|---|
Object |
HandlerInstantiator.includeFilterInstance(SerializationConfig config,
BeanPropertyDefinition forProperty,
Class<?> filterClass)
Method called to construct a Filter (any Object with implementation of
equals(Object) that determines if given value is to be
excluded (true) or included (false)) to be used based on
JsonInclude annotation (or
equivalent). |
abstract JsonSerializer<?> |
HandlerInstantiator.serializerInstance(SerializationConfig config,
Annotated annotated,
Class<?> serClass)
Method called to get an instance of serializer of specified type.
|
Modifier and Type | Method and Description |
---|---|
JsonSerializer<?> |
CoreXMLSerializers.findSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc) |
JsonSerializer<?> |
OptionalHandlerFactory.findSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc) |
Modifier and Type | Method and Description |
---|---|
BasicBeanDescription |
BasicClassIntrospector.forSerialization(SerializationConfig config,
JavaType type,
ClassIntrospector.MixInResolver r) |
abstract BeanDescription |
ClassIntrospector.forSerialization(SerializationConfig cfg,
JavaType type,
ClassIntrospector.MixInResolver r)
Factory method that constructs an introspector that has all
information needed for serialization purposes.
|
Modifier and Type | Method and Description |
---|---|
TypeSerializer |
TypeResolverBuilder.buildTypeSerializer(SerializationConfig config,
JavaType baseType,
Collection<NamedType> subtypes)
Method for building type serializer based on current configuration
of this builder.
|
Modifier and Type | Method and Description |
---|---|
TypeSerializer |
StdTypeResolverBuilder.buildTypeSerializer(SerializationConfig config,
JavaType baseType,
Collection<NamedType> subtypes) |
Modifier and Type | Field and Description |
---|---|
protected SerializationConfig |
PropertyBuilder._config |
protected SerializationConfig |
BeanSerializerBuilder._config |
Modifier and Type | Method and Description |
---|---|
protected JsonSerializer<?> |
BasicSerializerFactory.buildEnumSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc) |
protected JsonSerializer<?> |
BasicSerializerFactory.buildIterableSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc,
boolean staticTyping,
JavaType valueType) |
protected JsonSerializer<?> |
BasicSerializerFactory.buildIteratorSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc,
boolean staticTyping,
JavaType valueType) |
List<BeanPropertyWriter> |
BeanSerializerModifier.changeProperties(SerializationConfig config,
BeanDescription beanDesc,
List<BeanPropertyWriter> beanProperties)
Method called by
BeanSerializerFactory with tentative set
of discovered properties. |
protected PropertyBuilder |
BeanSerializerFactory.constructPropertyBuilder(SerializationConfig config,
BeanDescription beanDesc) |
abstract DefaultSerializerProvider |
DefaultSerializerProvider.createInstance(SerializationConfig config,
SerializerFactory jsf)
Method that sub-classes need to implement: used to create a non-blueprint instances
from the blueprint.
|
DefaultSerializerProvider.Impl |
DefaultSerializerProvider.Impl.createInstance(SerializationConfig config,
SerializerFactory jsf) |
abstract JsonSerializer<Object> |
SerializerFactory.createKeySerializer(SerializationConfig config,
JavaType type,
JsonSerializer<Object> defaultImpl)
Deprecated.
|
JsonSerializer<Object> |
BasicSerializerFactory.createKeySerializer(SerializationConfig config,
JavaType keyType,
JsonSerializer<Object> defaultImpl)
Deprecated.
|
abstract TypeSerializer |
SerializerFactory.createTypeSerializer(SerializationConfig config,
JavaType baseType)
Method called to create a type information serializer for given base type,
if one is needed.
|
TypeSerializer |
BasicSerializerFactory.createTypeSerializer(SerializationConfig config,
JavaType baseType)
Method called to construct a type serializer for values with given declared
base type.
|
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.
|
JsonSerializer<?> |
Serializers.findArraySerializer(SerializationConfig config,
ArrayType type,
BeanDescription beanDesc,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer)
Method called by serialization framework first time a serializer is needed for
specified array type.
|
JsonSerializer<?> |
Serializers.Base.findArraySerializer(SerializationConfig config,
ArrayType type,
BeanDescription beanDesc,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer) |
JsonSerializer<?> |
Serializers.findCollectionLikeSerializer(SerializationConfig config,
CollectionLikeType type,
BeanDescription beanDesc,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer)
Method called by serialization framework first time a serializer is needed for
specified "Collection-like" type (type that acts like
Collection ,
but does not implement it). |
JsonSerializer<?> |
Serializers.Base.findCollectionLikeSerializer(SerializationConfig config,
CollectionLikeType type,
BeanDescription beanDesc,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer) |
JsonSerializer<?> |
Serializers.findCollectionSerializer(SerializationConfig config,
CollectionType type,
BeanDescription beanDesc,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer)
Method called by serialization framework first time a serializer is needed for
specified
Collection type. |
JsonSerializer<?> |
Serializers.Base.findCollectionSerializer(SerializationConfig config,
CollectionType type,
BeanDescription beanDesc,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer) |
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.
|
JsonSerializer<?> |
Serializers.findMapLikeSerializer(SerializationConfig config,
MapLikeType type,
BeanDescription beanDesc,
JsonSerializer<Object> keySerializer,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer)
Method called by serialization framework first time a serializer is needed for
specified "Map-like" type (type that acts like
Map ,
but does not implement it). |
JsonSerializer<?> |
Serializers.Base.findMapLikeSerializer(SerializationConfig config,
MapLikeType type,
BeanDescription beanDesc,
JsonSerializer<Object> keySerializer,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer) |
JsonSerializer<?> |
Serializers.findMapSerializer(SerializationConfig config,
MapType type,
BeanDescription beanDesc,
JsonSerializer<Object> keySerializer,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer)
Method called by serialization framework first time a serializer is needed for
specified
Map type. |
JsonSerializer<?> |
Serializers.Base.findMapSerializer(SerializationConfig config,
MapType type,
BeanDescription beanDesc,
JsonSerializer<Object> keySerializer,
TypeSerializer elementTypeSerializer,
JsonSerializer<Object> elementValueSerializer) |
TypeSerializer |
BeanSerializerFactory.findPropertyContentTypeSerializer(JavaType containerType,
SerializationConfig config,
AnnotatedMember accessor)
Method called to create a type information serializer for values of given
container property
if one is needed.
|
TypeSerializer |
BeanSerializerFactory.findPropertyTypeSerializer(JavaType baseType,
SerializationConfig config,
AnnotatedMember accessor)
Method called to create a type information serializer for values of given
non-container property
if one is needed.
|
JsonSerializer<?> |
Serializers.findReferenceSerializer(SerializationConfig config,
ReferenceType type,
BeanDescription beanDesc,
TypeSerializer contentTypeSerializer,
JsonSerializer<Object> contentValueSerializer)
Method called by serialization framework first time a serializer is needed for
given
ReferenceType |
JsonSerializer<?> |
Serializers.Base.findReferenceSerializer(SerializationConfig config,
ReferenceType type,
BeanDescription beanDesc,
TypeSerializer contentTypeSerializer,
JsonSerializer<Object> contentValueSerializer) |
JsonSerializer<?> |
Serializers.findSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc)
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).
|
JsonSerializer<?> |
Serializers.Base.findSerializer(SerializationConfig config,
JavaType type,
BeanDescription beanDesc) |
protected JsonSerializer<?> |
BasicSerializerFactory.findSerializerByAddonType(SerializationConfig config,
JavaType javaType,
BeanDescription beanDesc,
boolean staticTyping)
Reflection-based serialized find method, which checks if
given class implements one of recognized "add-on" interfaces.
|
protected JsonSerializer<?> |
BasicSerializerFactory.findSerializerByLookup(JavaType type,
SerializationConfig config,
BeanDescription beanDesc,
boolean staticTyping)
Method that will use fast lookup (and identity comparison) methods to
see if we know serializer to use for given type.
|
void |
BeanPropertyWriter.fixAccess(SerializationConfig config)
Method called to ensure that the mutator has proper access rights to
be called, as per configuration.
|
void |
AnyGetterWriter.fixAccess(SerializationConfig config) |
JsonSerializer<?> |
BeanSerializerModifier.modifyArraySerializer(SerializationConfig config,
ArrayType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer)
Method called by
DeserializerFactory after it has constructed the
standard serializer for given
ArrayType
to make it possible to either replace or augment this serializer with
additional functionality. |
JsonSerializer<?> |
BeanSerializerModifier.modifyCollectionLikeSerializer(SerializationConfig config,
CollectionLikeType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer) |
JsonSerializer<?> |
BeanSerializerModifier.modifyCollectionSerializer(SerializationConfig config,
CollectionType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer) |
JsonSerializer<?> |
BeanSerializerModifier.modifyEnumSerializer(SerializationConfig config,
JavaType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer) |
JsonSerializer<?> |
BeanSerializerModifier.modifyKeySerializer(SerializationConfig config,
JavaType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer)
Method called by
DeserializerFactory after it has constructed the
default key serializer to use for serializing Map keys of
given type. |
JsonSerializer<?> |
BeanSerializerModifier.modifyMapLikeSerializer(SerializationConfig config,
MapLikeType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer) |
JsonSerializer<?> |
BeanSerializerModifier.modifyMapSerializer(SerializationConfig config,
MapType valueType,
BeanDescription beanDesc,
JsonSerializer<?> serializer) |
JsonSerializer<?> |
BeanSerializerModifier.modifySerializer(SerializationConfig config,
BeanDescription beanDesc,
JsonSerializer<?> serializer)
Method called by
BeanSerializerFactory after constructing default
bean serializer instance with properties collected and ordered earlier. |
List<BeanPropertyWriter> |
BeanSerializerModifier.orderProperties(SerializationConfig config,
BeanDescription beanDesc,
List<BeanPropertyWriter> beanProperties)
Method called by
BeanSerializerFactory 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.removeIgnorableTypes(SerializationConfig config,
BeanDescription beanDesc,
List<BeanPropertyDefinition> properties)
Method that will apply by-type limitations (as per [JACKSON-429]);
by default this is based on
JsonIgnoreType
annotation but can be supplied by module-provided introspectors too. |
protected void |
BeanSerializerFactory.removeSetterlessGetters(SerializationConfig config,
BeanDescription beanDesc,
List<BeanPropertyDefinition> properties)
Helper method that will remove all properties that do not have a mutator.
|
protected void |
BeanSerializerBuilder.setConfig(SerializationConfig config)
Initialization method called right after construction, to specify
configuration to use.
|
BeanSerializerBuilder |
BeanSerializerModifier.updateBuilder(SerializationConfig config,
BeanDescription beanDesc,
BeanSerializerBuilder builder)
Method called by
BeanSerializerFactory 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,
TypeSerializer typeSer)
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.
|
Constructor and Description |
---|
DefaultSerializerProvider(SerializerProvider src,
SerializationConfig config,
SerializerFactory f) |
Impl(SerializerProvider src,
SerializationConfig config,
SerializerFactory f) |
PropertyBuilder(SerializationConfig config,
BeanDescription beanDesc) |
Modifier and Type | Method and Description |
---|---|
static EnumSerializer |
EnumSerializer.construct(Class<?> enumClass,
SerializationConfig config,
BeanDescription beanDesc,
JsonFormat.Value format)
Factory method used by
BasicSerializerFactory
for constructing serializer instance of Enum types. |
static JsonSerializer<Object> |
StdKeySerializers.getFallbackKeySerializer(SerializationConfig config,
Class<?> rawKeyType)
Method called if no specified key serializer was located; will return a
"default" key serializer.
|
static JsonSerializer<Object> |
StdKeySerializers.getStdKeySerializer(SerializationConfig config,
Class<?> rawKeyType,
boolean useDefault) |
Modifier and Type | Method and Description |
---|---|
static EnumValues |
EnumValues.construct(SerializationConfig config,
Class<Enum<?>> enumClass)
NOTE: do NOT call this if configuration may change, and choice between toString()
and name() might change dynamically.
|
Copyright © 2008–2022 FasterXML. All rights reserved.