|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface Module.SetupContext
Interface Jackson exposes to modules for purpose of registering extended functionality.
Method Summary | |
---|---|
void |
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). |
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 write JsonToken.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 additional TypeModifier instance, which can augment JavaType
instances constructed by TypeFactory . |
void |
addValueInstantiators(ValueInstantiators instantiators)
Method that module can use to register additional ValueInstantiator s,
by adding ValueInstantiators object that gets called when
instantatiator is needed by a deserializer. |
void |
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. |
DeserializationConfig |
getDeserializationConfig()
Method that returns current deserialization configuration settings. |
Version |
getMapperVersion()
Method that returns version information about ObjectMapper
that implements this context. |
SerializationConfig |
getSerializationConfig()
Method that returns current serialization configuration settings. |
void |
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(DeserializationConfig.Feature f)
|
boolean |
isEnabled(JsonGenerator.Feature f)
|
boolean |
isEnabled(JsonParser.Feature f)
|
boolean |
isEnabled(SerializationConfig.Feature f)
|
void |
setMixInAnnotations(Class<?> target,
Class<?> mixinSource)
Method used for defining mix-in annotations to use for augmenting specified class or interface. |
Method Detail |
---|
Version getMapperVersion()
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.
DeserializationConfig getDeserializationConfig()
SerializationConfig getSerializationConfig()
boolean isEnabled(DeserializationConfig.Feature f)
boolean isEnabled(SerializationConfig.Feature f)
boolean isEnabled(JsonParser.Feature f)
boolean isEnabled(JsonGenerator.Feature f)
void addDeserializers(Deserializers d)
d
- Object that can be called to find deserializer for types supported
by module (null returned for non-supported types)void addKeyDeserializers(KeyDeserializers s)
void addSerializers(Serializers s)
s
- Object that can be called to find serializer for types supported
by module (null returned for non-supported types)void addKeySerializers(Serializers s)
JsonToken.FIELD_NAME
instead of String value).
void addBeanDeserializerModifier(BeanDeserializerModifier mod)
mod
- Modifier to registervoid addBeanSerializerModifier(BeanSerializerModifier mod)
mod
- Modifier to registervoid addAbstractTypeResolver(AbstractTypeResolver resolver)
AbstractTypeResolver
instance, to handle resolution of
abstract to concrete types (either by defaulting, or by materializing).
resolver
- Resolver to add.void addTypeModifier(TypeModifier modifier)
TypeModifier
instance, which can augment JavaType
instances constructed by TypeFactory
.
modifier
- to addvoid addValueInstantiators(ValueInstantiators instantiators)
ValueInstantiator
s,
by adding ValueInstantiators
object that gets called when
instantatiator is needed by a deserializer.
instantiators
- Object that can provide ValueInstantiator
s for
constructing POJO values during deserializationvoid insertAnnotationIntrospector(AnnotationIntrospector ai)
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)
ai
- Annotation introspector to register.void appendAnnotationIntrospector(AnnotationIntrospector ai)
AnnotationIntrospector
as the lowest
priority introspector, chained with existing introspector(s) and called
as fallback for cases not otherwise handled.
ai
- Annotation introspector to register.void setMixInAnnotations(Class<?> target, Class<?> mixinSource)
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.
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |