jackson-databind 2.16.0 · com.fasterxml.jackson.databind.cfg.BaseSettings

Field Summary

Modifier and Type	Field and Description
protected final AccessorNamingStrategy.Provider	_accessorNaming Provider for creating `AccessorNamingStrategy` instances to use
protected final AnnotationIntrospector	_annotationIntrospector Introspector used for accessing annotation value based configuration.
protected final CacheProvider	_cacheProvider Used to provide custom cache implementation in downstream components.
protected final ClassIntrospector	_classIntrospector Introspector used to figure out Bean properties needed for bean serialization and deserialization.
protected final DateFormat	_dateFormat Custom date format to use for deserialization.
protected final Base64Variant	_defaultBase64 Explicitly default `Base64Variant` to use for handling binary data (`byte[]`), used with data formats that use base64 encoding (like JSON, CSV).
protected final HandlerInstantiator	_handlerInstantiator Object used for creating instances of handlers (serializers, deserializers, type and type id resolvers), given class to instantiate.
protected final Locale	_locale Default `java.util.Locale` used with serialization formats.
protected final PropertyNamingStrategy	_propertyNamingStrategy Custom property naming strategy in use, if any.
protected final TimeZone	_timeZone Default `java.util.TimeZone` used with serialization formats, if (and only if!) explicitly set by use; otherwise `null` to indicate "use default", which means "UTC" (from Jackson 2.7); earlier versions (up to 2.6) used "GMT".
protected final TypeFactory	_typeFactory Specific factory used for creating `JavaType` instances; needed to allow modules to add more custom type handling (mostly to support types of non-Java JVM languages)
protected final TypeResolverBuilder<?>	_typeResolverBuilder Builder used to create type resolver for serializing and deserializing values for which polymorphic type handling is needed.
protected final PolymorphicTypeValidator	_typeValidator Validator that is used to limit allowed polymorphic subtypes, mostly for security reasons when dealing with untrusted content.
private static final TimeZone	DEFAULT_TIMEZONE We will use a default TimeZone as the baseline.
private static final long	serialVersionUID

Access	Constructor and Description
public	BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv, AccessorNamingStrategy.Provider accNaming, CacheProvider cacheProvider)
public	BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv, AccessorNamingStrategy.Provider accNaming) Deprecated Since 2.16, use variant that takes `CacheProvider` instead.
public	BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv) Deprecated

Method Summary

Modifier and Type	Method and Description
private DateFormat	_force(DateFormat df, TimeZone tz)
public BaseSettings	copy() Turns out we are not necessarily 100% stateless, alas, since `ClassIntrospector` typically has a cache.
public AccessorNamingStrategy.Provider	getAccessorNaming()
public AnnotationIntrospector	getAnnotationIntrospector()
public Base64Variant	getBase64Variant()
public CacheProvider	getCacheProvider()
public ClassIntrospector	getClassIntrospector()
public DateFormat	getDateFormat()
public HandlerInstantiator	getHandlerInstantiator()
public Locale	getLocale()
public PolymorphicTypeValidator	getPolymorphicTypeValidator()
public PropertyNamingStrategy	getPropertyNamingStrategy()
public TimeZone	getTimeZone()
public TypeFactory	getTypeFactory()
public TypeResolverBuilder<?>	getTypeResolverBuilder()
public boolean	hasExplicitTimeZone() Accessor that may be called to determine whether this settings object has been explicitly configured with a TimeZone (true), or is still relying on the default settings (false).
public BaseSettings	with(Locale l)
public BaseSettings	with(TimeZone tz) Fluent factory for constructing a new instance that uses specified TimeZone.
public BaseSettings	with(Base64Variant base64)
public BaseSettings	with(PolymorphicTypeValidator v)
public BaseSettings	Returns: a new instance with provided `CacheProvider`. with(CacheProvider cacheProvider) Fluent factory for constructing a new instance with provided `CacheProvider`.
public BaseSettings	withAccessorNaming(AccessorNamingStrategy.Provider p)
public BaseSettings	withAnnotationIntrospector(AnnotationIntrospector ai)
public BaseSettings	withAppendedAnnotationIntrospector(AnnotationIntrospector ai)
public BaseSettings	withClassIntrospector(ClassIntrospector ci)
public BaseSettings	withDateFormat(DateFormat df)
public BaseSettings	withHandlerInstantiator(HandlerInstantiator hi)
public BaseSettings	withInsertedAnnotationIntrospector(AnnotationIntrospector ai)
public BaseSettings	withPropertyNamingStrategy(PropertyNamingStrategy pns)
public BaseSettings	withTypeFactory(TypeFactory tf)
public BaseSettings	withTypeResolverBuilder(TypeResolverBuilder<?> typer)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_accessorNaming back to summary

_accessorNaming	back to summary
protected final AccessorNamingStrategy.Provider _accessorNaming Provider for creating `AccessorNamingStrategy` instances to use Since 2.12

protected final AccessorNamingStrategy.Provider _accessorNaming

Provider for creating AccessorNamingStrategy instances to use

Since: 2.12

_annotationIntrospector	back to summary
protected final AnnotationIntrospector _annotationIntrospector Introspector used for accessing annotation value based configuration.

_cacheProvider	back to summary
protected final CacheProvider _cacheProvider Used to provide custom cache implementation in downstream components. Since 2.16

_cacheProvider

back to summary

protected final CacheProvider _cacheProvider

Used to provide custom cache implementation in downstream components.

Since: 2.16

_classIntrospector	back to summary
protected final ClassIntrospector _classIntrospector Introspector used to figure out Bean properties needed for bean serialization and deserialization. Overridable so that it is possible to change low-level details of introspection, like adding new annotation types.

_dateFormat back to summary

_dateFormat	back to summary
protected final DateFormat _dateFormat Custom date format to use for deserialization. If specified, will be used instead of `com.fasterxml.jackson.databind.util.StdDateFormat`. Note that the configured format object will be cloned once per deserialization process (first time it is needed)

protected final DateFormat _dateFormat

Custom date format to use for deserialization. If specified, will be used instead of com.fasterxml.jackson.databind.util.StdDateFormat.

Note that the configured format object will be cloned once per deserialization process (first time it is needed)

_defaultBase64 back to summary

_defaultBase64	back to summary
protected final Base64Variant _defaultBase64 Explicitly default `Base64Variant` to use for handling binary data (`byte[]`), used with data formats that use base64 encoding (like JSON, CSV). Since 2.1

protected final Base64Variant _defaultBase64

Explicitly default Base64Variant to use for handling binary data (byte[]), used with data formats that use base64 encoding (like JSON, CSV).

Since: 2.1

_handlerInstantiator	back to summary
protected final HandlerInstantiator _handlerInstantiator Object used for creating instances of handlers (serializers, deserializers, type and type id resolvers), given class to instantiate. This is typically used to do additional configuration (with dependency injection, for example) beyond simply construction of instances; or to use alternative constructors.

_locale	back to summary
protected final Locale _locale Default `java.util.Locale` used with serialization formats. Default value is `Locale#getDefault()`.

_propertyNamingStrategy	back to summary
protected final PropertyNamingStrategy _propertyNamingStrategy Custom property naming strategy in use, if any.

_timeZone back to summary

_timeZone	back to summary
protected final TimeZone _timeZone Default `java.util.TimeZone` used with serialization formats, if (and only if!) explicitly set by use; otherwise `null` to indicate "use default", which means "UTC" (from Jackson 2.7); earlier versions (up to 2.6) used "GMT". Note that if a new value is set, timezone is also assigned to `_dateFormat` of this object.

protected final TimeZone _timeZone

Default java.util.TimeZone used with serialization formats, if (and only if!) explicitly set by use; otherwise `null` to indicate "use default", which means "UTC" (from Jackson 2.7); earlier versions (up to 2.6) used "GMT".

Note that if a new value is set, timezone is also assigned to _dateFormat of this object.

_typeFactory	back to summary
protected final TypeFactory _typeFactory Specific factory used for creating `JavaType` instances; needed to allow modules to add more custom type handling (mostly to support types of non-Java JVM languages)

_typeResolverBuilder	back to summary
protected final TypeResolverBuilder<?> _typeResolverBuilder Builder used to create type resolver for serializing and deserializing values for which polymorphic type handling is needed.

_typeValidator	back to summary
protected final PolymorphicTypeValidator _typeValidator Validator that is used to limit allowed polymorphic subtypes, mostly for security reasons when dealing with untrusted content. Since 2.10

_typeValidator

back to summary

protected final PolymorphicTypeValidator _typeValidator

Validator that is used to limit allowed polymorphic subtypes, mostly for security reasons when dealing with untrusted content.

Since: 2.10

DEFAULT_TIMEZONE	back to summary
private static final TimeZone DEFAULT_TIMEZONE We will use a default TimeZone as the baseline.

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

BaseSettings	back to summary
public BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv, AccessorNamingStrategy.Provider accNaming, CacheProvider cacheProvider) Since 2.16

BaseSettings back to summary

BaseSettings	back to summary
public BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv, AccessorNamingStrategy.Provider accNaming) Deprecated Since 2.16, use variant that takes `CacheProvider` instead. Annotations @Deprecated Since 2.12

public BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv, AccessorNamingStrategy.Provider accNaming)

Deprecated

Since 2.16, use variant that takes CacheProvider instead.

Annotations

@Deprecated

Since

2.12

BaseSettings	back to summary
public BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv) Deprecated Annotations @Deprecated

Method Detail

_force	back to summary
private DateFormat _force(DateFormat df, TimeZone tz)

copy back to summary

copy	back to summary
public BaseSettings copy() Turns out we are not necessarily 100% stateless, alas, since `ClassIntrospector` typically has a cache. So this method is needed for deep copy() of Mapper. Since 2.9.6

public BaseSettings copy()

Turns out we are not necessarily 100% stateless, alas, since ClassIntrospector typically has a cache. So this method is needed for deep copy() of Mapper.

Since: 2.9.6

getAccessorNaming	back to summary
public AccessorNamingStrategy.Provider getAccessorNaming()

getAnnotationIntrospector	back to summary
public AnnotationIntrospector getAnnotationIntrospector()

getBase64Variant	back to summary
public Base64Variant getBase64Variant()

getCacheProvider	back to summary
public CacheProvider getCacheProvider() Since 2.16

getClassIntrospector	back to summary
public ClassIntrospector getClassIntrospector()

getDateFormat	back to summary
public DateFormat getDateFormat()

getHandlerInstantiator	back to summary
public HandlerInstantiator getHandlerInstantiator()

getLocale	back to summary
public Locale getLocale()

getPolymorphicTypeValidator	back to summary
public PolymorphicTypeValidator getPolymorphicTypeValidator() Since 2.10

getPropertyNamingStrategy	back to summary
public PropertyNamingStrategy getPropertyNamingStrategy()

getTimeZone	back to summary
public TimeZone getTimeZone()

getTypeFactory	back to summary
public TypeFactory getTypeFactory()

getTypeResolverBuilder	back to summary
public TypeResolverBuilder<?> getTypeResolverBuilder()

hasExplicitTimeZone	back to summary
public boolean hasExplicitTimeZone() Accessor that may be called to determine whether this settings object has been explicitly configured with a TimeZone (true), or is still relying on the default settings (false). Since 2.7

hasExplicitTimeZone

back to summary

public boolean hasExplicitTimeZone()

Accessor that may be called to determine whether this settings object has been explicitly configured with a TimeZone (true), or is still relying on the default settings (false).

Since: 2.7

with	back to summary
public BaseSettings with(Locale l)

with	back to summary
public BaseSettings with(TimeZone tz) Fluent factory for constructing a new instance that uses specified TimeZone. Note that timezone used with also be assigned to configured `DateFormat`, changing time formatting defaults.

with	back to summary
public BaseSettings with(Base64Variant base64) Since 2.1

with	back to summary
public BaseSettings with(PolymorphicTypeValidator v) Since 2.10

with back to summary

with	back to summary
public BaseSettings with(CacheProvider cacheProvider) Fluent factory for constructing a new instance with provided `CacheProvider`. Returns:BaseSettings a new instance with provided `CacheProvider`. Since 2.16

public BaseSettings with(CacheProvider cacheProvider)

Fluent factory for constructing a new instance with provided CacheProvider.

Returns:BaseSettings: a new instance with provided CacheProvider.
Since: 2.16

withAccessorNaming	back to summary
public BaseSettings withAccessorNaming(AccessorNamingStrategy.Provider p)

withAnnotationIntrospector	back to summary
public BaseSettings withAnnotationIntrospector(AnnotationIntrospector ai)

withAppendedAnnotationIntrospector	back to summary
public BaseSettings withAppendedAnnotationIntrospector(AnnotationIntrospector ai)

withClassIntrospector	back to summary
public BaseSettings withClassIntrospector(ClassIntrospector ci)

withDateFormat	back to summary
public BaseSettings withDateFormat(DateFormat df)

withHandlerInstantiator	back to summary
public BaseSettings withHandlerInstantiator(HandlerInstantiator hi)

withInsertedAnnotationIntrospector	back to summary
public BaseSettings withInsertedAnnotationIntrospector(AnnotationIntrospector ai)

withPropertyNamingStrategy	back to summary
public BaseSettings withPropertyNamingStrategy(PropertyNamingStrategy pns)

withTypeFactory	back to summary
public BaseSettings withTypeFactory(TypeFactory tf)

withTypeResolverBuilder	back to summary
public BaseSettings withTypeResolverBuilder(TypeResolverBuilder<?> typer)

public final Class BaseSettings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail