|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.map.Module
org.codehaus.jackson.map.module.SimpleModule
public class SimpleModule
Simple Module
implementation that allows registration
of serializers and deserializers, and bean serializer
and deserializer modifiers.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.codehaus.jackson.map.Module |
---|
Module.SetupContext |
Field Summary | |
---|---|
protected SimpleAbstractTypeResolver |
_abstractTypes
Lazily-constructed resolver used for storing mappings from abstract classes to more specific implementing classes (which may be abstract or concrete) |
protected SimpleDeserializers |
_deserializers
|
protected SimpleKeyDeserializers |
_keyDeserializers
|
protected SimpleSerializers |
_keySerializers
|
protected HashMap<Class<?>,Class<?>> |
_mixins
Lazily-constructed map that contains mix-in definitions, indexed by target class, value being mix-in to apply. |
protected String |
_name
|
protected SimpleSerializers |
_serializers
|
protected SimpleValueInstantiators |
_valueInstantiators
Lazily-constructed resolver used for storing mappings from abstract classes to more specific implementing classes (which may be abstract or concrete) |
protected Version |
_version
|
Constructor Summary | |
---|---|
SimpleModule(String name,
Version version)
|
Method Summary | ||
---|---|---|
|
addAbstractTypeMapping(Class<T> superType,
Class<? extends T> subType)
Lazily-constructed resolver used for storing mappings from abstract classes to more specific implementing classes (which may be abstract or concrete) |
|
|
addDeserializer(Class<T> type,
JsonDeserializer<? extends T> deser)
|
|
SimpleModule |
addKeyDeserializer(Class<?> type,
KeyDeserializer deser)
|
|
|
addKeySerializer(Class<? extends T> type,
JsonSerializer<T> ser)
|
|
|
addSerializer(Class<? extends T> type,
JsonSerializer<T> ser)
|
|
SimpleModule |
addSerializer(JsonSerializer<?> ser)
|
|
SimpleModule |
addValueInstantiator(Class<?> beanType,
ValueInstantiator inst)
Method for registering ValueInstantiator to use when deserializing
instances of type beanType . |
|
String |
getModuleName()
Method that returns identifier for module; this can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them. |
|
void |
setAbstractTypes(SimpleAbstractTypeResolver atr)
Resets currently configured abstract type mappings |
|
void |
setDeserializers(SimpleDeserializers d)
Resets all currently configured deserializers. |
|
void |
setKeyDeserializers(SimpleKeyDeserializers kd)
Resets all currently configured key deserializers. |
|
void |
setKeySerializers(SimpleSerializers ks)
Resets all currently configured key serializers. |
|
SimpleModule |
setMixInAnnotation(Class<?> targetType,
Class<?> mixinClass)
Method for specifying that annotations define by mixinClass
should be "mixed in" with annotations that targetType
has (as if they were directly included on it!). |
|
void |
setSerializers(SimpleSerializers s)
Resets all currently configured serializers. |
|
void |
setupModule(Module.SetupContext context)
Method called by ObjectMapper when module is registered. |
|
void |
setValueInstantiators(SimpleValueInstantiators svi)
Resets all currently configured value instantiators |
|
Version |
version()
Method that returns version of this module. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final String _name
protected final Version _version
protected SimpleSerializers _serializers
protected SimpleDeserializers _deserializers
protected SimpleSerializers _keySerializers
protected SimpleKeyDeserializers _keyDeserializers
protected SimpleAbstractTypeResolver _abstractTypes
protected SimpleValueInstantiators _valueInstantiators
protected HashMap<Class<?>,Class<?>> _mixins
Constructor Detail |
---|
public SimpleModule(String name, Version version)
Method Detail |
---|
public void setSerializers(SimpleSerializers s)
public void setDeserializers(SimpleDeserializers d)
public void setKeySerializers(SimpleSerializers ks)
public void setKeyDeserializers(SimpleKeyDeserializers kd)
public void setAbstractTypes(SimpleAbstractTypeResolver atr)
public void setValueInstantiators(SimpleValueInstantiators svi)
public SimpleModule addSerializer(JsonSerializer<?> ser)
public <T> SimpleModule addSerializer(Class<? extends T> type, JsonSerializer<T> ser)
public <T> SimpleModule addKeySerializer(Class<? extends T> type, JsonSerializer<T> ser)
public <T> SimpleModule addDeserializer(Class<T> type, JsonDeserializer<? extends T> deser)
public SimpleModule addKeyDeserializer(Class<?> type, KeyDeserializer deser)
public <T> SimpleModule addAbstractTypeMapping(Class<T> superType, Class<? extends T> subType)
public SimpleModule addValueInstantiator(Class<?> beanType, ValueInstantiator inst)
ValueInstantiator
to use when deserializing
instances of type beanType
.
Instantiator is
registered when module is registered for ObjectMapper
.
public SimpleModule setMixInAnnotation(Class<?> targetType, Class<?> mixinClass)
mixinClass
should be "mixed in" with annotations that targetType
has (as if they were directly included on it!).
Mix-in annotations are
registered when module is registered for ObjectMapper
.
public String getModuleName()
Module
getModuleName
in class Module
public void setupModule(Module.SetupContext context)
Module
ObjectMapper
when module is registered.
It is called to let module register functionality it provides,
using callback methods passed-in context object exposes.
setupModule
in class Module
public Version version()
Module
version
in interface Versioned
version
in class Module
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |