Package org.codehaus.jackson.map
Class Module
- java.lang.Object
-
- org.codehaus.jackson.map.Module
-
- All Implemented Interfaces:
Versioned
- Direct Known Subclasses:
MrBeanModule
,SimpleModule
public abstract class Module extends java.lang.Object implements Versioned
Simple interface for extensions that can be registered withObjectMapper
to provide a well-defined set of extensions to default functionality; such as support for new data types.- Since:
- 1.7
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Module.SetupContext
Interface Jackson exposes to modules for purpose of registering extended functionality.
-
Constructor Summary
Constructors Constructor Description Module()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.lang.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.abstract void
setupModule(Module.SetupContext context)
Method called byObjectMapper
when module is registered.abstract Version
version()
Method that returns version of this module.
-
-
-
Method Detail
-
getModuleName
public abstract java.lang.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.
-
version
public abstract Version version()
Method that returns version of this module. Can be used by Jackson for informational purposes.
-
setupModule
public abstract void setupModule(Module.SetupContext context)
Method called byObjectMapper
when module is registered. It is called to let module register functionality it provides, using callback methods passed-in context object exposes.
-
-