Package com.fasterxml.jackson.databind.cfg

Class BaseSettings

java.lang.Object

com.fasterxml.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

Constructor Summary

Constructors

Constructor	Description
BaseSettings(ClassIntrospector ci, AnnotationIntrospector ai, PropertyNamingStrategy pns, TypeFactory tf, TypeResolverBuilder<?> typer, DateFormat dateFormat, HandlerInstantiator hi, Locale locale, TimeZone tz, Base64Variant defaultBase64, PolymorphicTypeValidator ptv)	Deprecated.
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.
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)

Method Summary

Modifier and Type	Method	Description
BaseSettings	copy()	Turns out we are not necessarily 100% stateless, alas, since ClassIntrospector typically has a cache.
AccessorNamingStrategy.Provider	getAccessorNaming()
AnnotationIntrospector	getAnnotationIntrospector()
Base64Variant	getBase64Variant()
CacheProvider	getCacheProvider()
ClassIntrospector	getClassIntrospector()
DateFormat	getDateFormat()
HandlerInstantiator	getHandlerInstantiator()
Locale	getLocale()
PolymorphicTypeValidator	getPolymorphicTypeValidator()
PropertyNamingStrategy	getPropertyNamingStrategy()
TimeZone	getTimeZone()
TypeFactory	getTypeFactory()
TypeResolverBuilder<?>	getTypeResolverBuilder()
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(Base64Variant base64)
BaseSettings	with(CacheProvider cacheProvider)	Fluent factory for constructing a new instance with provided CacheProvider.
BaseSettings	with(PolymorphicTypeValidator v)
BaseSettings	with(Locale l)
BaseSettings	with(TimeZone tz)	Fluent factory for constructing a new instance that uses specified TimeZone.
BaseSettings	withAccessorNaming(AccessorNamingStrategy.Provider p)
BaseSettings	withAnnotationIntrospector(AnnotationIntrospector ai)
BaseSettings	withAppendedAnnotationIntrospector(AnnotationIntrospector ai)
BaseSettings	withClassIntrospector(ClassIntrospector ci)
BaseSettings	withDateFormat(DateFormat df)
BaseSettings	withHandlerInstantiator(HandlerInstantiator hi)
BaseSettings	withInsertedAnnotationIntrospector(AnnotationIntrospector ai)
BaseSettings	withPropertyNamingStrategy(PropertyNamingStrategy pns)
BaseSettings	withTypeFactory(TypeFactory tf)
BaseSettings	withTypeResolverBuilder(TypeResolverBuilder<?> typer)

Methods inherited from class java.lang.Object

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

Constructor Details

BaseSettings

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

@Deprecated
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.

Since:

2.12

BaseSettings

@Deprecated
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 Details

copy

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

withClassIntrospector

public BaseSettings withClassIntrospector(ClassIntrospector ci)

withAnnotationIntrospector

public BaseSettings withAnnotationIntrospector(AnnotationIntrospector ai)

withInsertedAnnotationIntrospector

public BaseSettings withInsertedAnnotationIntrospector(AnnotationIntrospector ai)

withAppendedAnnotationIntrospector

public BaseSettings withAppendedAnnotationIntrospector(AnnotationIntrospector ai)

withPropertyNamingStrategy

public BaseSettings withPropertyNamingStrategy(PropertyNamingStrategy pns)

withAccessorNaming

public BaseSettings withAccessorNaming(AccessorNamingStrategy.Provider p)

withTypeFactory

public BaseSettings withTypeFactory(TypeFactory tf)

withTypeResolverBuilder

public BaseSettings withTypeResolverBuilder(TypeResolverBuilder<?> typer)

withDateFormat

public BaseSettings withDateFormat(DateFormat df)

withHandlerInstantiator

public BaseSettings withHandlerInstantiator(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)

Since:

2.1

with

public BaseSettings with(PolymorphicTypeValidator v)

Since:

2.10

with

public BaseSettings with(CacheProvider cacheProvider)

Fluent factory for constructing a new instance with provided CacheProvider.

Returns:

a new instance with provided CacheProvider.

Since:

2.16

getClassIntrospector

public ClassIntrospector getClassIntrospector()

getAnnotationIntrospector

public AnnotationIntrospector getAnnotationIntrospector()

getPropertyNamingStrategy

public PropertyNamingStrategy getPropertyNamingStrategy()

getAccessorNaming

public AccessorNamingStrategy.Provider getAccessorNaming()

getTypeFactory

public TypeFactory getTypeFactory()

getTypeResolverBuilder

public TypeResolverBuilder<?> getTypeResolverBuilder()

getPolymorphicTypeValidator

public PolymorphicTypeValidator getPolymorphicTypeValidator()

Since:

2.10

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

Since:

2.7

getBase64Variant

public Base64Variant getBase64Variant()

getCacheProvider

public CacheProvider getCacheProvider()

Since:

2.16