Module tools.jackson.databind

Package tools.jackson.databind.cfg

Class ModuleContextBase

java.lang.Object

tools.jackson.databind.cfg.ModuleContextBase

All Implemented Interfaces:

JacksonModule.SetupContext

public class ModuleContextBase
extends Object
implements JacksonModule.SetupContext

Default implementation of JacksonModule.SetupContext used by ObjectMapper.

Field Summary

Fields

Modifier and Type	Field	Description
protected final MapperBuilder<?,?>	_builder
protected final ConfigOverrides	_configOverrides

Constructor Summary

Constructors

Constructor	Description
ModuleContextBase(MapperBuilder<?,?> b, ConfigOverrides configOverrides)

Method Summary

Modifier and Type	Method	Description
protected DeserializerFactory	_deserializerFactory()
protected SerializerFactory	_serializerFactory()
protected void	_set(DeserializerFactory f)
protected void	_set(SerializerFactory f)
protected TokenStreamFactory	_streamFactory()
JacksonModule.SetupContext	addAbstractTypeResolver(AbstractTypeResolver resolver)	Method that module can use to register additional AbstractTypeResolver instance, to handle resolution of abstract to concrete types (either by defaulting, or by materializing).
JacksonModule.SetupContext	addDeserializerModifier(ValueDeserializerModifier modifier)	Method that module can use to register additional modifier objects to customize configuration and construction of bean deserializers.
JacksonModule.SetupContext	addDeserializers(Deserializers d)	Method that module can use to register additional deserializers to use for handling types.
JacksonModule.SetupContext	addHandler(DeserializationProblemHandler handler)	Add a deserialization problem handler
JacksonModule.SetupContext	addKeyDeserializers(KeyDeserializers kd)	Method that module can use to register additional deserializers to use for handling Map key values (which are separate from value deserializers because they are always serialized from String values)
JacksonModule.SetupContext	addKeySerializers(Serializers s)	Method that module can use to register additional serializers to use for handling Map key values (which are separate from value serializers because they must write JsonToken.FIELD_NAME instead of String value).
JacksonModule.SetupContext	addSerializerModifier(ValueSerializerModifier modifier)	Method that module can use to register additional modifier objects to customize configuration and construction of bean serializers.
JacksonModule.SetupContext	addSerializers(Serializers s)	Method that module can use to register additional serializers to use for handling types.
JacksonModule.SetupContext	addTypeModifier(TypeModifier modifier)	Method that module can use to register additional TypeModifier instance, which can augment JavaType instances constructed by TypeFactory.
JacksonModule.SetupContext	addValueInstantiators(ValueInstantiators instantiators)	Method that module can use to register additional ValueInstantiators, by adding ValueInstantiators object that gets called when instantatiator is needed by a deserializer.
JacksonModule.SetupContext	appendAnnotationIntrospector(AnnotationIntrospector ai)	Method for registering specified AnnotationIntrospector as the lowest priority introspector, chained with existing introspector(s) and called as fallback for cases not otherwise handled.
void	applyChanges(MapperBuilder<?,?> b)	Method called after all changes have been applied through this context, to propagate buffered or pending changes (if any) back to builder.
MutableConfigOverride	configOverride(Class<?> type)	"Mutant accessor" for getting a mutable configuration override object for given type, needed to add or change per-type overrides applied to properties of given type.
DatatypeFeatures	datatypeFeatures()
String	getFormatName()
Version	getMapperVersion()	Method that returns version information about ObjectMapper that implements this context.
Object	getOwner()	Fallback access method that allows modules to refer to the MapperBuilder that provided this context.
JacksonModule.SetupContext	insertAnnotationIntrospector(AnnotationIntrospector ai)	Method for registering specified AnnotationIntrospector as the highest priority introspector (will be chained with existing introspector(s) which will be used as fallbacks for cases this introspector does not handle)
boolean	isEnabled(StreamReadFeature f)
boolean	isEnabled(StreamWriteFeature f)
boolean	isEnabled(TokenStreamFactory.Feature f)
boolean	isEnabled(DatatypeFeature f)
boolean	isEnabled(DeserializationFeature f)
boolean	isEnabled(MapperFeature f)
boolean	isEnabled(SerializationFeature f)
JacksonModule.SetupContext	overrideDefaultNullKeySerializer(ValueSerializer<?> ser)	Method that module can use to override handler called to write JSON Object key for Map values.
JacksonModule.SetupContext	overrideDefaultNullValueSerializer(ValueSerializer<?> ser)	Method that module can use to override handler called to write Java `null` as a value (Property or Map value, Collection/array element).
JacksonModule.SetupContext	overrideInjectableValues(UnaryOperator<InjectableValues> v)	Replace default InjectableValues that have been configured to be used for mapper being built.
JacksonModule.SetupContext	registerSubtypes(Class<?>... subtypes)	Method for registering specified classes as subtypes (of supertype(s) they have)
JacksonModule.SetupContext	registerSubtypes(Collection<Class<?>> subtypes)	Method for registering specified classes as subtypes (of supertype(s) they have)
JacksonModule.SetupContext	registerSubtypes(NamedType... subtypes)	Method for registering specified classes as subtypes (of supertype(s) they have), using specified type names.
JacksonModule.SetupContext	setMixIn(Class<?> target, Class<?> mixinSource)	Method used for defining mix-in annotations to use for augmenting specified class or interface.
TokenStreamFactory	tokenStreamFactory()
TypeFactory	typeFactory()	Accessor for finding TypeFactory that is currently configured by the context.

Methods inherited from class java.lang.Object

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

Field Details

_builder

protected final MapperBuilder<?,?> _builder

_configOverrides

protected final ConfigOverrides _configOverrides

Constructor Details

ModuleContextBase

public ModuleContextBase(MapperBuilder<?,?> b,
 ConfigOverrides configOverrides)

Method Details

applyChanges

public void applyChanges(MapperBuilder<?,?> b)

Method called after all changes have been applied through this context, to propagate buffered or pending changes (if any) back to builder. Note that base implementation does nothing here; it is only provded in case sub-classes might need it.

getMapperVersion

public Version getMapperVersion()

Description copied from interface: JacksonModule.SetupContext

Method that returns version information about ObjectMapper that implements this context. Modules can use this to choose different settings or initialization order; or even decide to fail set up completely if version is compatible with module.

Specified by:

getMapperVersion in interface JacksonModule.SetupContext

getFormatName

public String getFormatName()

Specified by:

getFormatName in interface JacksonModule.SetupContext

getOwner

public Object getOwner()

Description copied from interface: JacksonModule.SetupContext

Fallback access method that allows modules to refer to the MapperBuilder that provided this context. It should NOT be needed by most modules; and ideally should not be used -- however, there may be cases where this may be necessary due to various design constraints.

NOTE: use of this method is discouraged, as it allows access to things Modules typically should not modify. It is included, however, to allow access to new features in cases where Module API has not yet been extended, or there are oversights.

Return value is chosen to force casting, to make caller aware that this is a fallback accessor, used only when everything else fails: type is, however, guaranteed to be MapperBuilder (and more specifically format-specific subtype that mapper constructed, in case format-specific access is needed).

Specified by:

getOwner in interface JacksonModule.SetupContext

typeFactory

public TypeFactory typeFactory()

Description copied from interface: JacksonModule.SetupContext

Accessor for finding TypeFactory that is currently configured by the context.

NOTE: since it is possible that other modules might change or replace TypeFactory, use of this method adds order-dependency for registrations.

Specified by:

typeFactory in interface JacksonModule.SetupContext

tokenStreamFactory

public TokenStreamFactory tokenStreamFactory()

Specified by:

tokenStreamFactory in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(MapperFeature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(DeserializationFeature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(SerializationFeature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(TokenStreamFactory.Feature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(StreamReadFeature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(StreamWriteFeature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

isEnabled

public boolean isEnabled(DatatypeFeature f)

Specified by:

isEnabled in interface JacksonModule.SetupContext

datatypeFeatures

public DatatypeFeatures datatypeFeatures()

Specified by:

datatypeFeatures in interface JacksonModule.SetupContext

addDeserializers

public JacksonModule.SetupContext addDeserializers(Deserializers d)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional deserializers to use for handling types.

Specified by:

addDeserializers in interface JacksonModule.SetupContext

Parameters:

d - Object that can be called to find deserializer for types supported by module (null returned for non-supported types)

See Also:

• is used to register key deserializers (for Map keys)

addKeyDeserializers

public JacksonModule.SetupContext addKeyDeserializers(KeyDeserializers kd)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional deserializers to use for handling Map key values (which are separate from value deserializers because they are always serialized from String values)

Specified by:

addKeyDeserializers in interface JacksonModule.SetupContext

addDeserializerModifier

public JacksonModule.SetupContext addDeserializerModifier(ValueDeserializerModifier modifier)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional modifier objects to customize configuration and construction of bean deserializers.

Specified by:

addDeserializerModifier in interface JacksonModule.SetupContext

Parameters:

modifier - Modifier to register

addValueInstantiators

public JacksonModule.SetupContext addValueInstantiators(ValueInstantiators instantiators)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional ValueInstantiators, by adding ValueInstantiators object that gets called when instantatiator is needed by a deserializer.

Specified by:

addValueInstantiators in interface JacksonModule.SetupContext

Parameters:

instantiators - Object that can provide ValueInstantiators for constructing POJO values during deserialization

addSerializers

public JacksonModule.SetupContext addSerializers(Serializers s)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional serializers to use for handling types.

Specified by:

addSerializers in interface JacksonModule.SetupContext

Parameters:

s - Object that can be called to find serializer for types supported by module (null returned for non-supported types)

See Also:

• is used to register key serializers (for Map keys)

addKeySerializers

public JacksonModule.SetupContext addKeySerializers(Serializers s)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional serializers to use for handling Map key values (which are separate from value serializers because they must write JsonToken.FIELD_NAME instead of String value).

Specified by:

addKeySerializers in interface JacksonModule.SetupContext

addSerializerModifier

public JacksonModule.SetupContext addSerializerModifier(ValueSerializerModifier modifier)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional modifier objects to customize configuration and construction of bean serializers.

Specified by:

addSerializerModifier in interface JacksonModule.SetupContext

Parameters:

modifier - Modifier to register

overrideDefaultNullKeySerializer

public JacksonModule.SetupContext overrideDefaultNullKeySerializer(ValueSerializer<?> ser)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to override handler called to write JSON Object key for Map values.

Specified by:

overrideDefaultNullKeySerializer in interface JacksonModule.SetupContext

Parameters:

ser - Serializer called to write output for JSON Object key of which value on Java side is `null`

overrideDefaultNullValueSerializer

public JacksonModule.SetupContext overrideDefaultNullValueSerializer(ValueSerializer<?> ser)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to override handler called to write Java `null` as a value (Property or Map value, Collection/array element).

Specified by:

overrideDefaultNullValueSerializer in interface JacksonModule.SetupContext

Parameters:

ser - Serializer called to write output for Java `null` as value (as distinct from key)

addAbstractTypeResolver

public JacksonModule.SetupContext addAbstractTypeResolver(AbstractTypeResolver resolver)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional AbstractTypeResolver instance, to handle resolution of abstract to concrete types (either by defaulting, or by materializing).

Specified by:

addAbstractTypeResolver in interface JacksonModule.SetupContext

Parameters:

resolver - Resolver to add.

addTypeModifier

public JacksonModule.SetupContext addTypeModifier(TypeModifier modifier)

Description copied from interface: JacksonModule.SetupContext

Method that module can use to register additional TypeModifier instance, which can augment JavaType instances constructed by TypeFactory.

Specified by:

addTypeModifier in interface JacksonModule.SetupContext

Parameters:

modifier - to add

registerSubtypes

public JacksonModule.SetupContext registerSubtypes(Class<?>... subtypes)

Description copied from interface: JacksonModule.SetupContext

Method for registering specified classes as subtypes (of supertype(s) they have)

Specified by:

registerSubtypes in interface JacksonModule.SetupContext

registerSubtypes

public JacksonModule.SetupContext registerSubtypes(NamedType... subtypes)

Description copied from interface: JacksonModule.SetupContext

Method for registering specified classes as subtypes (of supertype(s) they have), using specified type names.

Specified by:

registerSubtypes in interface JacksonModule.SetupContext

registerSubtypes

public JacksonModule.SetupContext registerSubtypes(Collection<Class<?>> subtypes)

Description copied from interface: JacksonModule.SetupContext

Method for registering specified classes as subtypes (of supertype(s) they have)

Specified by:

registerSubtypes in interface JacksonModule.SetupContext

insertAnnotationIntrospector

public JacksonModule.SetupContext insertAnnotationIntrospector(AnnotationIntrospector ai)

Description copied from interface: JacksonModule.SetupContext

Method for registering specified AnnotationIntrospector as the highest priority introspector (will be chained with existing introspector(s) which will be used as fallbacks for cases this introspector does not handle)

Specified by:

insertAnnotationIntrospector in interface JacksonModule.SetupContext

Parameters:

ai - Annotation introspector to register.

appendAnnotationIntrospector

public JacksonModule.SetupContext appendAnnotationIntrospector(AnnotationIntrospector ai)

Description copied from interface: JacksonModule.SetupContext

Method for registering specified AnnotationIntrospector as the lowest priority introspector, chained with existing introspector(s) and called as fallback for cases not otherwise handled.

Specified by:

appendAnnotationIntrospector in interface JacksonModule.SetupContext

Parameters:

ai - Annotation introspector to register.

configOverride

public MutableConfigOverride configOverride(Class<?> type)

Description copied from interface: JacksonModule.SetupContext

"Mutant accessor" for getting a mutable configuration override object for given type, needed to add or change per-type overrides applied to properties of given type. Usage is through returned object by colling "setter" methods, which directly modify override object and take effect directly. For example you can do

   mapper.configOverride(java.util.Date.class)
       .setFormat(JsonFormat.Value.forPattern("yyyy-MM-dd"));

to change the default format to use for properties of type Date (possibly further overridden by per-property annotations)

Specified by:

configOverride in interface JacksonModule.SetupContext

addHandler

public JacksonModule.SetupContext addHandler(DeserializationProblemHandler handler)

Description copied from interface: JacksonModule.SetupContext

Add a deserialization problem handler

Specified by:

addHandler in interface JacksonModule.SetupContext

Parameters:

handler - The deserialization problem handler

overrideInjectableValues

public JacksonModule.SetupContext overrideInjectableValues(UnaryOperator<InjectableValues> v)

Description copied from interface: JacksonModule.SetupContext

Replace default InjectableValues that have been configured to be used for mapper being built.

Specified by:

overrideInjectableValues in interface JacksonModule.SetupContext

setMixIn

public JacksonModule.SetupContext setMixIn(Class<?> target,
 Class<?> mixinSource)

Description copied from interface: JacksonModule.SetupContext

Method used for defining mix-in annotations to use for augmenting specified class or interface. All annotations from mixinSource are taken to override annotations that target (or its supertypes) has.

Note: mix-ins are registered both for serialization and deserialization (which can be different internally).

Note: currently only one set of mix-in annotations can be defined for a single class; so if multiple modules register mix-ins, highest priority one (last one registered) will have priority over other modules.

Specified by:

setMixIn in interface JacksonModule.SetupContext

Parameters:

target - Class (or interface) whose annotations to effectively override

mixinSource - Class (or interface) whose annotations are to be "added" to target's annotations, overriding as necessary

_streamFactory

protected TokenStreamFactory _streamFactory()

_deserializerFactory

protected DeserializerFactory _deserializerFactory()

_set

protected void _set(DeserializerFactory f)

_serializerFactory

protected SerializerFactory _serializerFactory()

_set

protected void _set(SerializerFactory f)