org.zalando.guild.api.json.fields.jackson

Class JsonFieldsModule

java.lang.Object

com.fasterxml.jackson.databind.Module

com.fasterxml.jackson.databind.module.SimpleModule

org.zalando.guild.api.json.fields.jackson.JsonFieldsModule

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, Serializable

public class JsonFieldsModule
extends com.fasterxml.jackson.databind.module.SimpleModule

Module that will enable field-based filtering.

Since:

23.09.2015

Author:

Sean Patrick Floyd (sean.floyd@zalando.de)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

com.fasterxml.jackson.databind.Module.SetupContext

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.module.SimpleModule

_abstractTypes, _deserializerModifier, _deserializers, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version

Method Summary

Modifier and Type	Method and Description
static JsonFieldsModule	createJsonFieldsModule(com.google.common.base.Supplier<org.zalando.guild.api.json.fields.java.model.FieldPredicate> predicateSupplier, ContextProvider contextProvider) Instantiate the module with a default JsonFieldsAnnotationIntrospector.
static JsonFieldsModule	createJsonFieldsModuleWithCustomIntrospector(com.google.common.base.Supplier<org.zalando.guild.api.json.fields.java.model.FieldPredicate> predicateSupplier, ContextProvider contextProvider, JsonFieldsAnnotationIntrospector introspector) Instantiate the module with a custom subclass of JsonFieldsAnnotationIntrospector.
void	setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)

Methods inherited from class com.fasterxml.jackson.databind.module.SimpleModule

addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, getTypeId, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setValueInstantiators, version

Methods inherited from class java.lang.Object

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

Method Detail

createJsonFieldsModuleWithCustomIntrospector

public static JsonFieldsModule createJsonFieldsModuleWithCustomIntrospector(@Nonnull
                                                                            com.google.common.base.Supplier<org.zalando.guild.api.json.fields.java.model.FieldPredicate> predicateSupplier,
                                                                            @Nonnull
                                                                            ContextProvider contextProvider,
                                                                            @Nonnull
                                                                            JsonFieldsAnnotationIntrospector introspector)

Instantiate the module with a custom subclass of JsonFieldsAnnotationIntrospector.

createJsonFieldsModule

public static JsonFieldsModule createJsonFieldsModule(@Nonnull
                                                      com.google.common.base.Supplier<org.zalando.guild.api.json.fields.java.model.FieldPredicate> predicateSupplier,
                                                      @Nonnull
                                                      ContextProvider contextProvider)

Instantiate the module with a default JsonFieldsAnnotationIntrospector.

setupModule

public void setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)

Overrides:

setupModule in class com.fasterxml.jackson.databind.module.SimpleModule