com.fasterxml.jackson.databind

Class Module

  • All Implemented Interfaces:
    com.fasterxml.jackson.core.Versioned
    Direct Known Subclasses:
    SimpleModule


    public abstract class Module
    extends Object
    implements com.fasterxml.jackson.core.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.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static interface  Module.SetupContext
      Interface Jackson exposes to modules for purpose of registering extended functionality.
    • Constructor Summary

      Constructors 
      Constructor and Description
      Module() 
    • Constructor Detail

      • Module

        public Module()
    • Method Detail

      • 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 com.fasterxml.jackson.core.Version version()
        Method that returns version of this module. Can be used by Jackson for informational purposes.
        Specified by:
        version in interface com.fasterxml.jackson.core.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.

Copyright © 2014 FasterXML. All Rights Reserved.