com.cerner.beadledom.client.jackson

Class AnnotatedJacksonModule

java.lang.Object

com.google.inject.AbstractModule

com.cerner.beadledom.client.jackson.AnnotatedJacksonModule

All Implemented Interfaces:

com.google.inject.Module

public class AnnotatedJacksonModule
extends com.google.inject.AbstractModule

A Guice module that provides Jackson JSON serialization using ObjectMapper.

This module provides the ObjectMapper in the context of the given BindingAnnotation.

With this module installed, you can add new Jackson modules to the ObjectMapper by adding bindings of Module using the Multibinder. Example:

     class MyModule extends AbstractModule {
       {@literal @}Override
       protected void configure() {
         Multibinder<Module> jacksonModuleBinder = Multibinder
             .newSetBinder(binder(), Module.class, MyBindingAnnotation.class);
         jacksonModuleBinder.addBinding().to(FoobarModule.class);
       }
     }
 

Binds:

• ObjectMapper annotated with the given clientBindingAnnotation
• JacksonJsonProvider annotated with the given clientBindingAnnotation via a guice provider ObjectMapperClientProvider
• A Multibinder for SerializationFeatureFlag annotated with clientBindingAnnotation
• A Multibinder for DeserializationFeatureFlag annotated with clientBindingAnnotation
• A Multibinder for JsonGeneratorFeatureFlag annotated with clientBindingAnnotation
• A Multibinder for JsonParserFeatureFlag annotated with clientBindingAnnotation
• A Multibinder for MapperFeatureFlag annotated with clientBindingAnnotation

Installs:

• MultibindingsScanner

This module also creates a new SetBinders for the following types annotated with the given BindingAnnotation

• Module
• SerializationFeatureFlag
• DeserializationFeatureFlag
• JsonGeneratorFeatureFlag
• JsonParserFeatureFlag
• MapperFeatureFlag

Since:

2.2

Author:

Sundeep Paruvu

See Also:

JacksonModule

Method Summary

Modifier and Type	Method and Description
protected void	configure()
static AnnotatedJacksonModule	with(Class<? extends Annotation> clientBindingAnnotation) A static method to create an instance of AnnotatedJacksonModule.

Methods inherited from class com.google.inject.AbstractModule

addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding

Methods inherited from class java.lang.Object

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

Method Detail

with

public static AnnotatedJacksonModule with(Class<? extends Annotation> clientBindingAnnotation)

A static method to create an instance of AnnotatedJacksonModule.

Parameters:

clientBindingAnnotation - a BindingAnnotation to which the ObjectMapper need to be annotated with.

Returns:

an instance of AnnotatedJacksonModule

configure

protected void configure()

Specified by:

configure in class com.google.inject.AbstractModule