Jackson 3.0.1 · tools.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 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 `java.util.Locale` used with serialization formats.
protected final JsonNodeFactory	_nodeFactory Factory used for constructing `tools.jackson.databind.JsonNode` instances.
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 PolymorphicTypeValidator	_typeValidator Validator that is used to limit allowed subtypes during polymorphic deserialization, 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(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 and Description
private DateFormat	_force(DateFormat df, TimeZone tz)
public AccessorNamingStrategy.Provider	getAccessorNaming()
public AnnotationIntrospector	getAnnotationIntrospector()
public Base64Variant	getBase64Variant()
public CacheProvider	getCacheProvider()
public ConstructorDetector	getConstructorDetector()
public DateFormat	getDateFormat()
public TypeResolverBuilder<?>	getDefaultTyper()
public EnumNamingStrategy	getEnumNamingStrategy()
public HandlerInstantiator	getHandlerInstantiator()
public Locale	getLocale()
public JsonNodeFactory	getNodeFactory()
public PolymorphicTypeValidator	getPolymorphicTypeValidator()
public PropertyNamingStrategy	getPropertyNamingStrategy()
public TimeZone	getTimeZone()
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(PropertyNamingStrategy pns)
public BaseSettings	with(EnumNamingStrategy ens)
public BaseSettings	with(AccessorNamingStrategy.Provider p)
public BaseSettings	with(TypeResolverBuilder<?> typer)
public BaseSettings	with(PolymorphicTypeValidator ptv)
public BaseSettings	with(DateFormat df)
public BaseSettings	with(HandlerInstantiator hi)
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	Returns: a new instance with provided `CacheProvider`. with(CacheProvider cacheProvider) Fluent factory for constructing a new instance with provided `CacheProvider`.
public BaseSettings	with(JsonNodeFactory nodeFactory)
public BaseSettings	with(ConstructorDetector ctorDetector)
public BaseSettings	withAnnotationIntrospector(AnnotationIntrospector ai)
public BaseSettings	withAppendedAnnotationIntrospector(AnnotationIntrospector ai)
public BaseSettings	withInsertedAnnotationIntrospector(AnnotationIntrospector ai)

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

Field Detail

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

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

_ctorDetector	back to summary
protected final ConstructorDetector _ctorDetector Handler that specifies some aspects of Constructor auto-detection.

_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 `tools.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 tools.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
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).

_defaultTyper	back to summary
protected final TypeResolverBuilder<?> _defaultTyper Type information handler used for "default typing".

_enumNamingStrategy	back to summary
protected final EnumNamingStrategy _enumNamingStrategy Custom enum naming strategy in use, if any.

_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()`.

_nodeFactory	back to summary
protected final JsonNodeFactory _nodeFactory Factory used for constructing `tools.jackson.databind.JsonNode` instances.

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

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

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

BaseSettings

back to summary

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 Detail

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

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

getConstructorDetector	back to summary
public ConstructorDetector getConstructorDetector()

getDateFormat	back to summary
public DateFormat getDateFormat()

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

getEnumNamingStrategy	back to summary
public EnumNamingStrategy getEnumNamingStrategy()

getHandlerInstantiator	back to summary
public HandlerInstantiator getHandlerInstantiator()

getLocale	back to summary
public Locale getLocale()

getNodeFactory	back to summary
public JsonNodeFactory getNodeFactory()

getPolymorphicTypeValidator	back to summary
public PolymorphicTypeValidator getPolymorphicTypeValidator()

getPropertyNamingStrategy	back to summary
public PropertyNamingStrategy getPropertyNamingStrategy()

getTimeZone	back to summary
public TimeZone getTimeZone()

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

with	back to summary
public BaseSettings with(PropertyNamingStrategy pns)

with	back to summary
public BaseSettings with(EnumNamingStrategy ens)

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

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

with	back to summary
public BaseSettings with(PolymorphicTypeValidator ptv)

with	back to summary
public BaseSettings with(DateFormat df)

with	back to summary
public BaseSettings with(HandlerInstantiator hi)

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)

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

public BaseSettings with(CacheProvider cacheProvider)

Fluent factory for constructing a new instance with provided CacheProvider.

Returns:BaseSettings: a new instance with provided CacheProvider.

with	back to summary
public BaseSettings with(JsonNodeFactory nodeFactory)

with	back to summary
public BaseSettings with(ConstructorDetector ctorDetector)

withAnnotationIntrospector	back to summary
public BaseSettings withAnnotationIntrospector(AnnotationIntrospector ai)

withAppendedAnnotationIntrospector	back to summary
public BaseSettings withAppendedAnnotationIntrospector(AnnotationIntrospector ai)

withInsertedAnnotationIntrospector	back to summary
public BaseSettings withInsertedAnnotationIntrospector(AnnotationIntrospector ai)

public final Class BaseSettings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail