Jackson 3.0.1 · tools.jackson.databind.SerializationConfig

Field Summary

Modifier and Type	Field and 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 `tools.jackson.core.FormatFeature`s to enable/disable.
protected final int	_serFeatures Set of `SerializationFeature`s enabled.
protected final int	_streamWriteFeatures States of `tools.jackson.core.StreamWriteFeature`s to enable/disable.
private static final long	serialVersionUID Hides tools.jackson.databind.cfg.MapperConfig.serialVersionUID.

Inherited from tools.jackson.databind.cfg.MapperConfigBase:: _attributes _classIntrospector _configOverrides _datatypeFeatures _mixIns _rootName _rootNames _subtypeResolver _typeFactory _typeResolverProvider _view EMPTY_OVERRIDE

Constructor Summary

Access	Constructor and Description
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)
private	SerializationConfig(SerializationConfig src, int serFeatures, int streamWriteFeatures, int formatWriteFeatures)
private	SerializationConfig(SerializationConfig src, BaseSettings base)
private	SerializationConfig(SerializationConfig src, FilterProvider filters)
private	SerializationConfig(SerializationConfig src, Class<?> view)
private	SerializationConfig(SerializationConfig src, PropertyName rootName)
protected	SerializationConfig(SerializationConfig src, ContextAttributes attrs)
protected	SerializationConfig(SerializationConfig src, PrettyPrinter defaultPP)
protected	SerializationConfig(SerializationConfig src, DatatypeFeatures dtFeatures)

Method Summary

Modifier and Type	Method and Description
protected final SerializationConfig	_with(DatatypeFeatures dtFeatures) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._with.
protected final SerializationConfig	_withBase(BaseSettings newBase) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._withBase.
public PrettyPrinter	constructDefaultPrettyPrinter()
public Converter<Object, Object>	findSerializationConverter(Annotated ann)
public PrettyPrinter	getDefaultPrettyPrinter() Accessor for configured blueprint "default" `PrettyPrinter` to use, if default pretty-printing is enabled.
public FilterProvider	getFilterProvider() Method for getting provider used for locating filters given id (which is usually provided with filter annotations).
public int	getFormatWriteFeatures()
public final int	getSerializationFeatures()
public int	getStreamWriteFeatures()
public final boolean	hasFormatFeature(FormatFeature f)
public final boolean	hasSerializationFeatures(int featureMask) "Bulk" access method for checking that all features specified by mask are enabled.
public final boolean	Returns: True if feature is enabled; false otherwise isEnabled(SerializationFeature Feature to check feature) Accessor for checking whether give `SerializationFeature` is enabled or not.
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.
public boolean	useRootWrapping() Implements abstract tools.jackson.databind.cfg.MapperConfig.useRootWrapping. Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not.
public SerializationConfig	with(ContextAttributes attrs) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.with. Method for constructing an instance that has specified contextual attributes.
public SerializationConfig	with(DateFormat df) Overrides tools.jackson.databind.cfg.MapperConfigBase.with. In addition to constructing instance with specified date format, will enable or disable `DateTimeFeature.WRITE_DATES_AS_TIMESTAMPS` (enable if format set as null; disable if non-null)
public SerializationConfig	with(SerializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.
public SerializationConfig	with(SerializationFeature first, SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public SerializationConfig	with(StreamWriteFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.
public SerializationConfig	with(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.
public SerializationConfig	withDefaultPrettyPrinter(PrettyPrinter pp)
public SerializationConfig	withFeatures(SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public SerializationConfig	withFeatures(StreamWriteFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public SerializationConfig	withFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
public SerializationConfig	withFilters(FilterProvider filterProvider)
public SerializationConfig	without(SerializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.
public SerializationConfig	without(SerializationFeature first, SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public SerializationConfig	without(StreamWriteFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.
public SerializationConfig	without(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.
public SerializationConfig	withoutFeatures(SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public SerializationConfig	withoutFeatures(StreamWriteFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public SerializationConfig	withoutFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.
public SerializationConfig	withRootName(PropertyName rootName) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withRootName. Method for constructing and returning a new instance with different root name to use (none, if null).
public SerializationConfig	withView(Class<?> view) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withView. Method for constructing and returning a new instance with different view to use.

Field Detail

_defaultPrettyPrinter	back to summary
protected final PrettyPrinter _defaultPrettyPrinter If "default pretty-printing" is enabled, it will create the instance from this blueprint object.

_filterProvider	back to summary
protected final FilterProvider _filterProvider Object used for resolving filter ids to filter instances. Non-null if explicitly defined; null by default.

_formatWriteFeatures	back to summary
protected final int _formatWriteFeatures States of `tools.jackson.core.FormatFeature`s to enable/disable.

_serFeatures	back to summary
protected final int _serFeatures Set of `SerializationFeature`s enabled.

_streamWriteFeatures	back to summary
protected final int _streamWriteFeatures States of `tools.jackson.core.StreamWriteFeature`s to enable/disable.

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.cfg.MapperConfig.serialVersionUID.

Constructor Detail

SerializationConfig	back to summary
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	back to summary
private SerializationConfig(SerializationConfig src, int serFeatures, int streamWriteFeatures, int formatWriteFeatures)

SerializationConfig	back to summary
private SerializationConfig(SerializationConfig src, BaseSettings base)

SerializationConfig	back to summary
private SerializationConfig(SerializationConfig src, FilterProvider filters)

SerializationConfig	back to summary
private SerializationConfig(SerializationConfig src, Class<?> view)

SerializationConfig	back to summary
private SerializationConfig(SerializationConfig src, PropertyName rootName)

SerializationConfig	back to summary
protected SerializationConfig(SerializationConfig src, ContextAttributes attrs)

SerializationConfig	back to summary
protected SerializationConfig(SerializationConfig src, PrettyPrinter defaultPP)

SerializationConfig	back to summary
protected SerializationConfig(SerializationConfig src, DatatypeFeatures dtFeatures)

Method Detail

_with	back to summary
protected final SerializationConfig _with(DatatypeFeatures dtFeatures) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._with. Annotations @Override

_with

back to summary

protected final SerializationConfig _with(DatatypeFeatures dtFeatures)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase._with.

Annotations

@Override

_withBase	back to summary
protected final SerializationConfig _withBase(BaseSettings newBase) Implements abstract tools.jackson.databind.cfg.MapperConfigBase._withBase. Annotations @Override

_withBase

back to summary

protected final SerializationConfig _withBase(BaseSettings newBase)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase._withBase.

Annotations

@Override

constructDefaultPrettyPrinter	back to summary
public PrettyPrinter constructDefaultPrettyPrinter()

findSerializationConverter	back to summary
public Converter<Object, Object> findSerializationConverter(Annotated ann)

getDefaultPrettyPrinter	back to summary
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.

getFilterProvider	back to summary
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`)

getFormatWriteFeatures	back to summary
public int getFormatWriteFeatures() Since 3.0

getSerializationFeatures	back to summary
public final int getSerializationFeatures()

getStreamWriteFeatures	back to summary
public int getStreamWriteFeatures() Since 3.0

hasFormatFeature	back to summary
public final boolean hasFormatFeature(FormatFeature f)

hasSerializationFeatures	back to summary
public final boolean hasSerializationFeatures(int featureMask) "Bulk" access method for checking that all features specified by mask are enabled.

isEnabled back to summary

isEnabled	back to summary
public final boolean isEnabled(SerializationFeature feature) Accessor for checking whether give `SerializationFeature` is enabled or not. Parameters feature:SerializationFeature Feature to check Returns:boolean True if feature is enabled; false otherwise

public final boolean isEnabled(SerializationFeature feature)

Accessor for checking whether give SerializationFeature is enabled or not.

Parameters

feature:SerializationFeature: Feature to check

Returns:boolean

True if feature is enabled; false otherwise

isEnabled	back to summary
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.

useRootWrapping	back to summary
public boolean useRootWrapping() Implements abstract tools.jackson.databind.cfg.MapperConfig.useRootWrapping. Doc from tools.jackson.databind.cfg.MapperConfig.useRootWrapping. Accessor for checking whether configuration indicates that "root wrapping" (use of an extra property/name pair at root level) is expected or not. Annotations @Override

useRootWrapping

back to summary

public boolean useRootWrapping()

Implements abstract tools.jackson.databind.cfg.MapperConfig.useRootWrapping.

Doc from tools.jackson.databind.cfg.MapperConfig.useRootWrapping.

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

Annotations

@Override

with	back to summary
public SerializationConfig with(ContextAttributes attrs) Implements abstract tools.jackson.databind.cfg.MapperConfigBase.with. Doc from tools.jackson.databind.cfg.MapperConfigBase.with. Method for constructing an instance that has specified contextual attributes. Annotations @Override

with

back to summary

public SerializationConfig with(ContextAttributes attrs)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase.with.

Doc from tools.jackson.databind.cfg.MapperConfigBase.with.

Method for constructing an instance that has specified contextual attributes.

Annotations

@Override

with back to summary

with	back to summary
public SerializationConfig with(DateFormat df) Overrides tools.jackson.databind.cfg.MapperConfigBase.with. In addition to constructing instance with specified date format, will enable or disable `DateTimeFeature.WRITE_DATES_AS_TIMESTAMPS` (enable if format set as null; disable if non-null) Annotations @Override

public SerializationConfig with(DateFormat df)

Overrides tools.jackson.databind.cfg.MapperConfigBase.with.

In addition to constructing instance with specified date format, will enable or disable DateTimeFeature.WRITE_DATES_AS_TIMESTAMPS (enable if format set as null; disable if non-null)

Annotations

@Override

with	back to summary
public SerializationConfig with(SerializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.

with	back to summary
public SerializationConfig with(SerializationFeature first, SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

with	back to summary
public SerializationConfig with(StreamWriteFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.

with	back to summary
public SerializationConfig with(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature enabled.

withDefaultPrettyPrinter	back to summary
public SerializationConfig withDefaultPrettyPrinter(PrettyPrinter pp)

withFeatures	back to summary
public SerializationConfig withFeatures(SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFeatures	back to summary
public SerializationConfig withFeatures(StreamWriteFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFeatures	back to summary
public SerializationConfig withFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features enabled.

withFilters	back to summary
public SerializationConfig withFilters(FilterProvider filterProvider)

without	back to summary
public SerializationConfig without(SerializationFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

without	back to summary
public SerializationConfig without(SerializationFeature first, SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

without	back to summary
public SerializationConfig without(StreamWriteFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

without	back to summary
public SerializationConfig without(FormatFeature feature) Fluent factory method that will construct and return a new configuration object instance with specified feature disabled.

withoutFeatures	back to summary
public SerializationConfig withoutFeatures(SerializationFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withoutFeatures	back to summary
public SerializationConfig withoutFeatures(StreamWriteFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withoutFeatures	back to summary
public SerializationConfig withoutFeatures(FormatFeature... features) Fluent factory method that will construct and return a new configuration object instance with specified features disabled.

withRootName back to summary

public SerializationConfig withRootName(PropertyName rootName)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withRootName.

Doc from tools.jackson.databind.cfg.MapperConfigBase.withRootName.

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.

Annotations

@Override

withView

back to summary

public SerializationConfig withView(Class<?> view)

Implements abstract tools.jackson.databind.cfg.MapperConfigBase.withView.

Doc from tools.jackson.databind.cfg.MapperConfigBase.withView.

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

Annotations

@Override

public final Class SerializationConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail