Package org.codehaus.jackson.map
Interface Module.SetupContext
-
- Enclosing class:
- Module
public static interface Module.SetupContext
Interface Jackson exposes to modules for purpose of registering extended functionality.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAbstractTypeResolver(AbstractTypeResolver resolver)
Method that module can use to register additionalAbstractTypeResolver
instance, to handle resolution of abstract to concrete types (either by defaulting, or by materializing).void
addBeanDeserializerModifier(BeanDeserializerModifier mod)
Method that module can use to register additional modifier objects to customize configuration and construction of bean deserializers.void
addBeanSerializerModifier(BeanSerializerModifier mod)
Method that module can use to register additional modifier objects to customize configuration and construction of bean serializers.void
addDeserializers(Deserializers d)
Method that module can use to register additional deserializers to use for handling types.void
addKeyDeserializers(KeyDeserializers s)
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)void
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 writeJsonToken.FIELD_NAME
instead of String value).void
addSerializers(Serializers s)
Method that module can use to register additional serializers to use for handling types.void
addTypeModifier(TypeModifier modifier)
Method that module can use to register additionalTypeModifier
instance, which can augmentJavaType
instances constructed byTypeFactory
.void
addValueInstantiators(ValueInstantiators instantiators)
Method that module can use to register additionalValueInstantiator
s, by addingValueInstantiators
object that gets called when instantatiator is needed by a deserializer.void
appendAnnotationIntrospector(AnnotationIntrospector ai)
Method for registering specifiedAnnotationIntrospector
as the lowest priority introspector, chained with existing introspector(s) and called as fallback for cases not otherwise handled.DeserializationConfig
getDeserializationConfig()
Method that returns current deserialization configuration settings.Version
getMapperVersion()
Method that returns version information aboutObjectMapper
that implements this context.SerializationConfig
getSerializationConfig()
Method that returns current serialization configuration settings.void
insertAnnotationIntrospector(AnnotationIntrospector ai)
Method for registering specifiedAnnotationIntrospector
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(JsonGenerator.Feature f)
boolean
isEnabled(JsonParser.Feature f)
boolean
isEnabled(DeserializationConfig.Feature f)
boolean
isEnabled(SerializationConfig.Feature f)
void
setMixInAnnotations(java.lang.Class<?> target, java.lang.Class<?> mixinSource)
Method used for defining mix-in annotations to use for augmenting specified class or interface.
-
-
-
Method Detail
-
getMapperVersion
Version getMapperVersion()
Method that returns version information aboutObjectMapper
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.
-
getDeserializationConfig
DeserializationConfig getDeserializationConfig()
Method that returns current deserialization configuration settings. Since modules may be interested in these settings, caller should make sure to make changes to settings before module registrations.
-
getSerializationConfig
SerializationConfig getSerializationConfig()
Method that returns current serialization configuration settings. Since modules may be interested in these settings, caller should make sure to make changes to settings before module registrations.- Since:
- 1.7.1 (1.7.0 unfortunately had a typo in method name!)
-
isEnabled
boolean isEnabled(DeserializationConfig.Feature f)
- Since:
- 1.9.0
-
isEnabled
boolean isEnabled(SerializationConfig.Feature f)
- Since:
- 1.9.0
-
isEnabled
boolean isEnabled(JsonParser.Feature f)
- Since:
- 1.9.0
-
isEnabled
boolean isEnabled(JsonGenerator.Feature f)
- Since:
- 1.9.0
-
addDeserializers
void addDeserializers(Deserializers d)
Method that module can use to register additional deserializers to use for handling types.- Parameters:
d
- Object that can be called to find deserializer for types supported by module (null returned for non-supported types)
-
addKeyDeserializers
void addKeyDeserializers(KeyDeserializers s)
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)- Since:
- 1.8
-
addSerializers
void addSerializers(Serializers s)
Method that module can use to register additional serializers to use for handling types.- Parameters:
s
- Object that can be called to find serializer for types supported by module (null returned for non-supported types)
-
addKeySerializers
void 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 writeJsonToken.FIELD_NAME
instead of String value).- Since:
- 1.8
-
addBeanDeserializerModifier
void addBeanDeserializerModifier(BeanDeserializerModifier mod)
Method that module can use to register additional modifier objects to customize configuration and construction of bean deserializers.- Parameters:
mod
- Modifier to register
-
addBeanSerializerModifier
void addBeanSerializerModifier(BeanSerializerModifier mod)
Method that module can use to register additional modifier objects to customize configuration and construction of bean serializers.- Parameters:
mod
- Modifier to register
-
addAbstractTypeResolver
void addAbstractTypeResolver(AbstractTypeResolver resolver)
Method that module can use to register additionalAbstractTypeResolver
instance, to handle resolution of abstract to concrete types (either by defaulting, or by materializing).- Parameters:
resolver
- Resolver to add.- Since:
- 1.8
-
addTypeModifier
void addTypeModifier(TypeModifier modifier)
Method that module can use to register additionalTypeModifier
instance, which can augmentJavaType
instances constructed byTypeFactory
.- Parameters:
modifier
- to add- Since:
- 1.8
-
addValueInstantiators
void addValueInstantiators(ValueInstantiators instantiators)
Method that module can use to register additionalValueInstantiator
s, by addingValueInstantiators
object that gets called when instantatiator is needed by a deserializer.- Parameters:
instantiators
- Object that can provideValueInstantiator
s for constructing POJO values during deserialization- Since:
- 1.9
-
insertAnnotationIntrospector
void insertAnnotationIntrospector(AnnotationIntrospector ai)
Method for registering specifiedAnnotationIntrospector
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)- Parameters:
ai
- Annotation introspector to register.
-
appendAnnotationIntrospector
void appendAnnotationIntrospector(AnnotationIntrospector ai)
Method for registering specifiedAnnotationIntrospector
as the lowest priority introspector, chained with existing introspector(s) and called as fallback for cases not otherwise handled.- Parameters:
ai
- Annotation introspector to register.
-
setMixInAnnotations
void setMixInAnnotations(java.lang.Class<?> target, java.lang.Class<?> mixinSource)
Method used for defining mix-in annotations to use for augmenting specified class or interface. All annotations frommixinSource
are taken to override annotations thattarget
(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.
- Parameters:
target
- Class (or interface) whose annotations to effectively overridemixinSource
- Class (or interface) whose annotations are to be "added" to target's annotations, overriding as necessary
-
-