Module tools.jackson.databind

Package tools.jackson.databind.cfg

Class BaseSettings

java.lang.Object

tools.jackson.databind.cfg.BaseSettings

All Implemented Interfaces:

Serializable

public final class BaseSettings
extends Object
implements Serializable

Immutable container class used to store simple configuration settings for both serialization and deserialization. Since instances are fully immutable, instances can be freely shared and used without synchronization.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	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 ConstructorDetector	_ctorDetector	Handler that specifies some aspects of Constructor auto-detection.
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 TypeResolverBuilder<?>	_defaultTyper	Type information handler used for "default typing".
protected final EnumNamingStrategy	_enumNamingStrategy	Custom enum naming strategy in use, if any.
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 Locale used with serialization formats.
protected final JsonNodeFactory	_nodeFactory	Factory used for constructing JsonNode instances.
protected final PropertyNamingStrategy	_propertyNamingStrategy	Custom property naming strategy in use, if any.
protected final TimeZone	_timeZone	Default TimeZone used with serialization formats, if (and only if!)
protected final PolymorphicTypeValidator	_typeValidator	Validator that is used to limit allowed subtypes during polymorphic deserialization, mostly for security reasons when dealing with untrusted content.

Constructor Summary

Constructors

Constructor	Description
BaseSettings(AnnotationIntrospector ai, PropertyNamingStrategy pns, EnumNamingStrategy ens, AccessorNamingStrategy.Provider accNaming, TypeResolverBuilder<?> defaultTyper, PolymorphicTypeValidator ptv, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, CacheProvider cacheProvider, JsonNodeFactory nodeFactory, ConstructorDetector ctorDetector)

Method Summary

Modifier and Type	Method	Description
AccessorNamingStrategy.Provider	getAccessorNaming()
AnnotationIntrospector	getAnnotationIntrospector()
Base64Variant	getBase64Variant()
CacheProvider	getCacheProvider()
ConstructorDetector	getConstructorDetector()
DateFormat	getDateFormat()
TypeResolverBuilder<?>	getDefaultTyper()
EnumNamingStrategy	getEnumNamingStrategy()
HandlerInstantiator	getHandlerInstantiator()
Locale	getLocale()
JsonNodeFactory	getNodeFactory()
PolymorphicTypeValidator	getPolymorphicTypeValidator()
PropertyNamingStrategy	getPropertyNamingStrategy()
TimeZone	getTimeZone()
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).
BaseSettings	with(DateFormat df)
BaseSettings	with(Locale l)
BaseSettings	with(TimeZone tz)	Fluent factory for constructing a new instance that uses specified TimeZone.
BaseSettings	with(Base64Variant base64)
BaseSettings	with(CacheProvider cacheProvider)	Fluent factory for constructing a new instance with provided CacheProvider.
BaseSettings	with(ConstructorDetector ctorDetector)
BaseSettings	with(HandlerInstantiator hi)
BaseSettings	with(EnumNamingStrategy ens)
BaseSettings	with(AccessorNamingStrategy.Provider p)
BaseSettings	with(PolymorphicTypeValidator ptv)
BaseSettings	with(TypeResolverBuilder<?> typer)
BaseSettings	with(JsonNodeFactory nodeFactory)
BaseSettings	with(PropertyNamingStrategy pns)
BaseSettings	withAnnotationIntrospector(AnnotationIntrospector ai)
BaseSettings	withAppendedAnnotationIntrospector(AnnotationIntrospector ai)
BaseSettings	withInsertedAnnotationIntrospector(AnnotationIntrospector ai)

Methods inherited from class java.lang.Object

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

Field Details

_annotationIntrospector

protected final AnnotationIntrospector _annotationIntrospector

Introspector used for accessing annotation value based configuration.

_propertyNamingStrategy

protected final PropertyNamingStrategy _propertyNamingStrategy

Custom property naming strategy in use, if any.

_enumNamingStrategy

protected final EnumNamingStrategy _enumNamingStrategy

Custom enum naming strategy in use, if any.

_accessorNaming

protected final AccessorNamingStrategy.Provider _accessorNaming

Provider for creating AccessorNamingStrategy instances to use

_defaultTyper

protected final TypeResolverBuilder<?> _defaultTyper

Type information handler used for "default typing".

_typeValidator

protected final PolymorphicTypeValidator _typeValidator

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

_dateFormat

protected final DateFormat _dateFormat

Custom date format to use for deserialization. If specified, will be used instead of StdDateFormat.

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

_handlerInstantiator

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

protected final Locale _locale

Default Locale used with serialization formats. Default value is Locale.getDefault().

_timeZone

protected final TimeZone _timeZone

Default 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.

_defaultBase64

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

_cacheProvider

protected final CacheProvider _cacheProvider

Used to provide custom cache implementation in downstream components.

_nodeFactory

protected final JsonNodeFactory _nodeFactory

Factory used for constructing JsonNode instances.

_ctorDetector

protected final ConstructorDetector _ctorDetector

Handler that specifies some aspects of Constructor auto-detection.

Constructor Details

BaseSettings

public BaseSettings(AnnotationIntrospector ai,
 PropertyNamingStrategy pns,
 EnumNamingStrategy ens,
 AccessorNamingStrategy.Provider accNaming,
 TypeResolverBuilder<?> defaultTyper,
 PolymorphicTypeValidator ptv,
 DateFormat dateFormat,
 HandlerInstantiator hi,
 Locale locale,
 TimeZone tz,
 Base64Variant defaultBase64,
 CacheProvider cacheProvider,
 JsonNodeFactory nodeFactory,
 ConstructorDetector ctorDetector)

Method Details

withAnnotationIntrospector

public BaseSettings withAnnotationIntrospector(AnnotationIntrospector ai)

withInsertedAnnotationIntrospector

public BaseSettings withInsertedAnnotationIntrospector(AnnotationIntrospector ai)

withAppendedAnnotationIntrospector

public BaseSettings withAppendedAnnotationIntrospector(AnnotationIntrospector ai)

with

public BaseSettings with(PropertyNamingStrategy pns)

with

public BaseSettings with(EnumNamingStrategy ens)

with

public BaseSettings with(AccessorNamingStrategy.Provider p)

with

public BaseSettings with(TypeResolverBuilder<?> typer)

with

public BaseSettings with(PolymorphicTypeValidator ptv)

with

public BaseSettings with(DateFormat df)

with

public BaseSettings with(HandlerInstantiator hi)

with

public BaseSettings with(Locale l)

with

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

public BaseSettings with(Base64Variant base64)

with

public BaseSettings with(CacheProvider cacheProvider)

Fluent factory for constructing a new instance with provided CacheProvider.

Returns:

a new instance with provided CacheProvider.

with

public BaseSettings with(JsonNodeFactory nodeFactory)

with

public BaseSettings with(ConstructorDetector ctorDetector)

getAnnotationIntrospector

public AnnotationIntrospector getAnnotationIntrospector()

getPropertyNamingStrategy

public PropertyNamingStrategy getPropertyNamingStrategy()

getEnumNamingStrategy

public EnumNamingStrategy getEnumNamingStrategy()

getAccessorNaming

public AccessorNamingStrategy.Provider getAccessorNaming()

getDefaultTyper

public TypeResolverBuilder<?> getDefaultTyper()

getPolymorphicTypeValidator

public PolymorphicTypeValidator getPolymorphicTypeValidator()

getDateFormat

public DateFormat getDateFormat()

getHandlerInstantiator

public HandlerInstantiator getHandlerInstantiator()

getLocale

public Locale getLocale()

getTimeZone

public TimeZone getTimeZone()

hasExplicitTimeZone

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

getBase64Variant

public Base64Variant getBase64Variant()

getCacheProvider

public CacheProvider getCacheProvider()

getNodeFactory

public JsonNodeFactory getNodeFactory()

getConstructorDetector

public ConstructorDetector getConstructorDetector()