Class Module
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.Module
- All Implemented Interfaces:
Versioned
- Direct Known Subclasses:
SimpleModule
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
Modifier and TypeClassDescriptionstatic interface
Interface Jackson exposes to modules for purpose of registering extended functionality. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the list of dependent modules this module has, if any.abstract String
Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.Method that returns an id that may be used to determine if twoModule
instances are considered to be of same type, for purpose of preventing multiple registrations of "same type of" module (seeMapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS
) If `null` is returned, every instance is considered unique.abstract void
setupModule
(Module.SetupContext context) Method called byObjectMapper
when module is registered.abstract Version
version()
Method that returns version of this module.
-
Constructor Details
-
Module
public Module()
-
-
Method Details
-
getModuleName
Method that returns a display that can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them. -
version
Method that returns version of this module. Can be used by Jackson for informational purposes. -
getTypeId
Method that returns an id that may be used to determine if twoModule
instances are considered to be of same type, for purpose of preventing multiple registrations of "same type of" module (seeMapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS
) If `null` is returned, every instance is considered unique. If non-null value is returned, equality of id Objects is used to check whether modules should be considered to be "of same type"Default implementation returns value of class name (
Class.getName()
).- Since:
- 2.5
-
setupModule
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. -
getDependencies
Returns the list of dependent modules this module has, if any. It is called to let modules register other modules as dependencies. Modules returned will be registered before this module is registered, in iteration order.- Since:
- 2.10
-