Class Module

java.lang.Object

org.codehaus.jackson.map.Module

All Implemented Interfaces:

Versioned

Direct Known Subclasses:

MrBeanModule, SimpleModule

public abstract class Module
extends Object
implements Versioned

Simple interface for extensions that can be registered with ObjectMapper 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

Modifier and Type	Method	Description
abstract 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 by ObjectMapper when module is registered.
abstract Version	version()	Method that returns version of this module.

Methods inherited from class Object

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

Constructor Details

Module

public Module()

Method Details

getModuleName

public abstract 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.

Specified by:

version in interface Versioned

setupModule

public abstract void setupModule(Module.SetupContext context)

Method called by ObjectMapper when module is registered. It is called to let module register functionality it provides, using callback methods passed-in context object exposes.