Module tools.jackson.databind

Package tools.jackson.databind

Class SerializationConfig

java.lang.Object

tools.jackson.databind.cfg.MapperConfig<T>

tools.jackson.databind.cfg.MapperConfigBase<SerializationFeature,SerializationConfig>

tools.jackson.databind.SerializationConfig

All Implemented Interfaces:

Serializable, Snapshottable<MixInResolver>, MixInResolver

public final class SerializationConfig
extends MapperConfigBase<SerializationFeature,SerializationConfig>
implements Serializable

Object that contains baseline configuration for serialization process. An instance is owned by ObjectMapper, which passes an immutable instance for serialization process to SerializationContext and SerializerFactory (either directly, or through ObjectWriter.

Note that instances are considered immutable and as such no copies should need to be created for sharing; all copying is done with "fluent factory" methods.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final PrettyPrinter	_defaultPrettyPrinter	If "default pretty-printing" is enabled, it will create the instance from this blueprint object.
protected final FilterProvider	_filterProvider	Object used for resolving filter ids to filter instances.
protected final int	_formatWriteFeatures	States of FormatFeatures to enable/disable.
protected final int	_serFeatures	Set of SerializationFeatures enabled.
protected final int	_streamWriteFeatures	States of StreamWriteFeatures to enable/disable.

Fields inherited from class tools.jackson.databind.cfg.MapperConfigBase

_attributes, _classIntrospector, _configOverrides, _datatypeFeatures, _mixIns, _rootName, _rootNames, _subtypeResolver, _typeFactory, _typeResolverProvider, _view, EMPTY_OVERRIDE

Fields inherited from class tools.jackson.databind.cfg.MapperConfig

_base, _mapperFeatures, EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors

Modifier	Constructor	Description
	SerializationConfig(MapperBuilder<?,?> b, long mapperFeatures, int serFeatures, int streamWriteFeatures, int formatWriteFeatures, ConfigOverrides configOverrides, TypeFactory tf, ClassIntrospector classIntr, MixInHandler mixins, SubtypeResolver str, ContextAttributes defaultAttrs, RootNameLookup rootNames, FilterProvider filterProvider)
protected	SerializationConfig(SerializationConfig src, PrettyPrinter defaultPP)
protected	SerializationConfig(SerializationConfig src, ContextAttributes attrs)
protected	SerializationConfig(SerializationConfig src, DatatypeFeatures dtFeatures)

Method Summary

Modifier and Type	Method	Description
protected final SerializationConfig	_with(DatatypeFeatures dtFeatures)
protected final SerializationConfig	_withBase(BaseSettings newBase)
PrettyPrinter	constructDefaultPrettyPrinter()
PrettyPrinter	getDefaultPrettyPrinter()	Accessor for configured blueprint "default" PrettyPrinter to use, if default pretty-printing is enabled.
FilterProvider	getFilterProvider()	Method for getting provider used for locating filters given id (which is usually provided with filter annotations).
int	getFormatWriteFeatures()
final int	getSerializationFeatures()
int	getStreamWriteFeatures()
final boolean	hasFormatFeature(FormatFeature f)
final boolean	hasSerializationFeatures(int featureMask)	"Bulk" access method for checking that all features specified by mask are enabled.
final boolean	isEnabled(StreamWriteFeature f)	Accessor method that first checks if we have any overrides for feature, and only if not, checks state of passed-in factory.
final boolean	isEnabled(SerializationFeature feature)	Accessor for checking whether give SerializationFeature is enabled or not.
boolean	useRootWrapping()	Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not.
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	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)	Method for constructing an instance that has specified contextual attributes.
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)	Method for constructing and returning a new instance with different root name to use (none, if null).
SerializationConfig	withView(Class<?> view)	Method for constructing and returning a new instance with different view to use.

Methods inherited from class tools.jackson.databind.cfg.MapperConfigBase

_datatypeFeatures, classIntrospectorInstance, constructType, constructType, findConfigOverride, findMixInClassFor, findRootName, findRootName, getActiveView, getAttributes, getConfigOverride, getDatatypeFeatures, getDefaultInclusion, getDefaultMergeable, getDefaultMergeable, getDefaultNullHandling, getDefaultPropertyFormat, getDefaultPropertyIgnorals, getDefaultPropertyIgnorals, getDefaultPropertyInclusion, getDefaultPropertyInclusion, getDefaultPropertyInclusions, getDefaultVisibilityChecker, getDefaultVisibilityChecker, getFullRootName, getSubtypeResolver, getTypeFactory, getTypeResolverProvider, hasMixIns, isEnabled, mixInCount, snapshot, with, with, with, with, with, with, with, with, withAttribute, withAttributes, withFeatures, without, withoutAttribute, withoutFeatures, withRootName

Methods inherited from class tools.jackson.databind.cfg.MapperConfig

canOverrideAccessModifiers, compileString, getAccessorNaming, getAnnotationIntrospector, getBase64Variant, getCacheProvider, getConstructorDetector, getDateFormat, getDefaultInclusion, getDefaultPropertyInclusion, getDefaultTyper, getEnumNamingStrategy, getHandlerInstantiator, getLocale, getNodeFactory, getPolymorphicTypeValidator, getPropertyNamingStrategy, getTimeZone, hasExplicitTimeZone, isAnnotationProcessingEnabled, isEnabled, shouldSortPropertiesAlphabetically, typeIdResolverInstance, typeResolverBuilderInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_filterProvider

protected final FilterProvider _filterProvider

Object used for resolving filter ids to filter instances. Non-null if explicitly defined; null by default.

_defaultPrettyPrinter

protected final PrettyPrinter _defaultPrettyPrinter

If "default pretty-printing" is enabled, it will create the instance from this blueprint object.

_serFeatures

protected final int _serFeatures

Set of SerializationFeatures enabled.

_streamWriteFeatures

protected final int _streamWriteFeatures

States of StreamWriteFeatures to enable/disable.

_formatWriteFeatures

protected final int _formatWriteFeatures

States of FormatFeatures to enable/disable.

Constructor Details

SerializationConfig

public SerializationConfig(MapperBuilder<?,?> b,
 long mapperFeatures,
 int serFeatures,
 int streamWriteFeatures,
 int formatWriteFeatures,
 ConfigOverrides configOverrides,
 TypeFactory tf,
 ClassIntrospector classIntr,
 MixInHandler mixins,
 SubtypeResolver str,
 ContextAttributes defaultAttrs,
 RootNameLookup rootNames,
 FilterProvider filterProvider)

Since:

3.0

SerializationConfig

protected SerializationConfig(SerializationConfig src,
 ContextAttributes attrs)

SerializationConfig

protected SerializationConfig(SerializationConfig src,
 PrettyPrinter defaultPP)

SerializationConfig

protected SerializationConfig(SerializationConfig src,
 DatatypeFeatures dtFeatures)

Method Details

_withBase

protected final SerializationConfig _withBase(BaseSettings newBase)

Specified by:

_withBase in class MapperConfigBase<SerializationFeature,SerializationConfig>

_with

protected final SerializationConfig _with(DatatypeFeatures dtFeatures)

Specified by:

_with in class MapperConfigBase<SerializationFeature,SerializationConfig>

withRootName

public SerializationConfig withRootName(PropertyName rootName)

Description copied from class: MapperConfigBase

Method for constructing and returning a new instance with different root name to use (none, if null).

Note that when a root name is set to a non-Empty String, this will automatically force use of root element wrapping with given name. If empty String passed, will disable root name wrapping; and if null used, will instead use SerializationFeature to determine if to use wrapping, and annotation (or default name) for actual root name to use.

Specified by:

withRootName in class MapperConfigBase<SerializationFeature,SerializationConfig>

Parameters:

rootName - to use: if null, means "use default" (clear setting); if empty String ("") means that no root name wrapping is used; otherwise defines root name to use.

withView

public SerializationConfig withView(Class<?> view)

Description copied from class: MapperConfigBase

Method for constructing and returning a new instance with different view to use.

Specified by:

withView in class MapperConfigBase<SerializationFeature,SerializationConfig>

with

public SerializationConfig with(ContextAttributes attrs)

Description copied from class: MapperConfigBase

Method for constructing an instance that has specified contextual attributes.

Specified by:

with in class MapperConfigBase<SerializationFeature,SerializationConfig>

with

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

Overrides:

with in class MapperConfigBase<SerializationFeature,SerializationConfig>

with

public SerializationConfig with(SerializationFeature feature)

Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.

with

public SerializationConfig with(SerializationFeature first,
 SerializationFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFeatures

public SerializationConfig withFeatures(SerializationFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

without

public SerializationConfig without(SerializationFeature feature)

Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

without

public SerializationConfig without(SerializationFeature first,
 SerializationFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withoutFeatures

public SerializationConfig withoutFeatures(SerializationFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

with

public SerializationConfig with(StreamWriteFeature feature)

Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.

withFeatures

public SerializationConfig withFeatures(StreamWriteFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

without

public SerializationConfig without(StreamWriteFeature feature)

Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

withoutFeatures

public SerializationConfig withoutFeatures(StreamWriteFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

with

public SerializationConfig with(FormatFeature feature)

Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.

withFeatures

public SerializationConfig withFeatures(FormatFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

without

public SerializationConfig without(FormatFeature feature)

Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

withoutFeatures

public SerializationConfig withoutFeatures(FormatFeature... features)

Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withFilters

public SerializationConfig withFilters(FilterProvider filterProvider)

withDefaultPrettyPrinter

public SerializationConfig withDefaultPrettyPrinter(PrettyPrinter pp)

constructDefaultPrettyPrinter

public PrettyPrinter constructDefaultPrettyPrinter()

getStreamWriteFeatures

public int getStreamWriteFeatures()

Since:

3.0

getFormatWriteFeatures

public int getFormatWriteFeatures()

Since:

3.0

useRootWrapping

public boolean useRootWrapping()

Description copied from class: MapperConfig

Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not.

Specified by:

useRootWrapping in class MapperConfig<SerializationConfig>

isEnabled

public final boolean isEnabled(SerializationFeature feature)

Accessor for checking whether give SerializationFeature is enabled or not.

Parameters:

feature - Feature to check

Returns:

True if feature is enabled; false otherwise

isEnabled

public final boolean isEnabled(StreamWriteFeature f)

Accessor method that first checks if we have any overrides for feature, and only if not, checks state of passed-in factory.

hasFormatFeature

public final boolean hasFormatFeature(FormatFeature f)

hasSerializationFeatures

public final boolean hasSerializationFeatures(int featureMask)

"Bulk" access method for checking that all features specified by mask are enabled.

getSerializationFeatures

public final int getSerializationFeatures()

getFilterProvider

public FilterProvider getFilterProvider()

Method for getting provider used for locating filters given id (which is usually provided with filter annotations). Will be null if no provided was set for ObjectWriter (or if serialization directly called from ObjectMapper)

getDefaultPrettyPrinter

public PrettyPrinter getDefaultPrettyPrinter()

Accessor for configured blueprint "default" PrettyPrinter to use, if default pretty-printing is enabled.

NOTE: returns the "blueprint" instance, and does NOT construct an instance ready to use; call constructDefaultPrettyPrinter() if actually usable instance is desired.