com.devonfw.module.json.common.base

Class ObjectMapperFactory

java.lang.Object

com.devonfw.module.json.common.base.ObjectMapperFactory

public class ObjectMapperFactory
extends Object

A generic factory to create instances of a Jackson ObjectMapper. It allows to configure the ObjectMapper for polymorphic transfer-objects.

Since:

3.0.0

See Also:

setBaseClasses(Class...), setSubtypes(NamedType...)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	ARTIFACT_ID
private List<Class<?>>	baseClassList
private com.fasterxml.jackson.databind.module.SimpleModule	extensionModule
(package private) static String	GROUP_ID
private List<com.fasterxml.jackson.databind.jsontype.NamedType>	subtypeList

Constructor Summary

Constructors

Constructor and Description
ObjectMapperFactory() The constructor.

Method Summary

Modifier and Type	Method and Description
void	addBaseClasses(Class<?>... baseClasses)
void	addSubtypes(com.fasterxml.jackson.databind.jsontype.NamedType... subtypes)
com.fasterxml.jackson.databind.ObjectMapper	createInstance()
com.fasterxml.jackson.databind.module.SimpleModule	getExtensionModule() Gets access to a generic extension module for customizations to Jackson JSON mapping.
void	setBaseClasses(Class<?>... baseClasses)
void	setSubtypeList(List<com.fasterxml.jackson.databind.jsontype.NamedType> subtypeList)
void	setSubtypes(com.fasterxml.jackson.databind.jsontype.NamedType... subtypeList)

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ID

static final String GROUP_ID

See Also:

Constant Field Values

ARTIFACT_ID

static final String ARTIFACT_ID

See Also:

Constant Field Values

baseClassList

private List<Class<?>> baseClassList

subtypeList

private List<com.fasterxml.jackson.databind.jsontype.NamedType> subtypeList

extensionModule

private com.fasterxml.jackson.databind.module.SimpleModule extensionModule

Constructor Detail

ObjectMapperFactory

public ObjectMapperFactory()

The constructor.

Method Detail

getExtensionModule

public com.fasterxml.jackson.databind.module.SimpleModule getExtensionModule()

Gets access to a generic extension module for customizations to Jackson JSON mapping.

Returns:

extensionModule

See Also:

SimpleModule.addSerializer(Class, com.fasterxml.jackson.databind.JsonSerializer), SimpleModule.addDeserializer(Class, com.fasterxml.jackson.databind.JsonDeserializer)

setBaseClasses

public void setBaseClasses(Class<?>... baseClasses)

Parameters:

baseClasses - are the base classes that are polymorphic (e.g. abstract transfer-object classes that have sub-types). You also need to register all sub-types of these polymorphic classes via setSubtypes(NamedType...).

addBaseClasses

public void addBaseClasses(Class<?>... baseClasses)

Parameters:

baseClasses - the base-classes to add to base classes list.

See Also:

setBaseClasses(Class...)

setSubtypeList

public void setSubtypeList(List<com.fasterxml.jackson.databind.jsontype.NamedType> subtypeList)

Parameters:

subtypeList - the List of NamedTypes to register the subtypes.

See Also:

setSubtypes(NamedType...)

addSubtypes

public void addSubtypes(com.fasterxml.jackson.databind.jsontype.NamedType... subtypes)

Parameters:

subtypes - the NamedTypes to add to sub-type list for registration.

See Also:

setSubtypes(NamedType...)

setSubtypes

public void setSubtypes(com.fasterxml.jackson.databind.jsontype.NamedType... subtypeList)

Parameters:

subtypeList - the NamedTypes as pair of Class reflecting a polymorphic sub-type together with its unique name in JSON format.

createInstance

public com.fasterxml.jackson.databind.ObjectMapper createInstance()

Returns:

an instance of ObjectMapper configured for polymorphic resolution.