Package org.eclipse.emfcloud.jackson.module

Class EMFModule

java.lang.Object

com.fasterxml.jackson.databind.Module

com.fasterxml.jackson.databind.module.SimpleModule

org.eclipse.emfcloud.jackson.module.EMFModule

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned, Serializable

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

Module implementation that allows serialization and deserialization of EMF objects (EObject and Resource).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EMFModule.Feature	Enumeration that defines all possible options that can be used to customize the behaviour of the EMF Module.

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

com.fasterxml.jackson.databind.Module.SetupContext

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DEFAULT_FEATURES
protected int	moduleFeatures

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

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

Constructor Summary

Constructors

Constructor	Description
EMFModule()

Method Summary

Modifier and Type	Method	Description
EMFModule	configure(EMFModule.Feature feature, boolean state)	Configures the module with one of possible Feature.
int	getFeatures()
EcoreIdentityInfo	getIdentityInfo()
String	getModuleName()
com.fasterxml.jackson.databind.JsonDeserializer<ReferenceEntry>	getReferenceDeserializer()
EcoreReferenceInfo	getReferenceInfo()
com.fasterxml.jackson.databind.JsonSerializer<org.eclipse.emf.ecore.EObject>	getReferenceSerializer()
EcoreTypeInfo	getTypeInfo()
URIHandler	getUriHandler()	Returns the URIHandler that will be used to de/resolve URIs during de/serialization.
boolean	isEnabled(EMFModule.Feature f)	Returns true if the current feature is used by the module.
void	setIdentityInfo(EcoreIdentityInfo identityInfo)
void	setReferenceDeserializer(com.fasterxml.jackson.databind.JsonDeserializer<ReferenceEntry> deserializer)
void	setReferenceInfo(EcoreReferenceInfo referenceInfo)
void	setReferenceSerializer(com.fasterxml.jackson.databind.JsonSerializer<org.eclipse.emf.ecore.EObject> serializer)
void	setTypeInfo(EcoreTypeInfo info)
static com.fasterxml.jackson.databind.ObjectMapper	setupDefaultMapper()	Returns a pre configured mapper with the EMF module.
static com.fasterxml.jackson.databind.ObjectMapper	setupDefaultMapper(com.fasterxml.jackson.core.JsonFactory factory)	Returns a pre configured mapper using the EMF module and the specified jackson factory.
void	setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
void	setUriHandler(URIHandler handler)	Tells the module which URIHandler to use to de/resolve URIs during de/serialization.
com.fasterxml.jackson.core.Version	version()

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

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

Methods inherited from class com.fasterxml.jackson.databind.Module

getDependencies

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FEATURES

protected static final int DEFAULT_FEATURES

moduleFeatures

protected int moduleFeatures

Constructor Detail

EMFModule

public EMFModule()

Method Detail

setTypeInfo

public void setTypeInfo(EcoreTypeInfo info)

setIdentityInfo

public void setIdentityInfo(EcoreIdentityInfo identityInfo)

setReferenceInfo

public void setReferenceInfo(EcoreReferenceInfo referenceInfo)

setReferenceSerializer

public void setReferenceSerializer(com.fasterxml.jackson.databind.JsonSerializer<org.eclipse.emf.ecore.EObject> serializer)

getReferenceSerializer

public com.fasterxml.jackson.databind.JsonSerializer<org.eclipse.emf.ecore.EObject> getReferenceSerializer()

setReferenceDeserializer

public void setReferenceDeserializer(com.fasterxml.jackson.databind.JsonDeserializer<ReferenceEntry> deserializer)

getReferenceDeserializer

public com.fasterxml.jackson.databind.JsonDeserializer<ReferenceEntry> getReferenceDeserializer()

setupDefaultMapper

public static com.fasterxml.jackson.databind.ObjectMapper setupDefaultMapper()

Returns a pre configured mapper with the EMF module.

Returns:

mapper

setupDefaultMapper

public static com.fasterxml.jackson.databind.ObjectMapper setupDefaultMapper(com.fasterxml.jackson.core.JsonFactory factory)

Returns a pre configured mapper using the EMF module and the specified jackson factory. This method can be used to work with formats others than JSON (such as YAML).

Parameters:

factory - Jackson factory

Returns:

mapper

setupModule

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

Overrides:

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

getModuleName

public String getModuleName()

Overrides:

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

version

public com.fasterxml.jackson.core.Version version()

Specified by:

version in interface com.fasterxml.jackson.core.Versioned

Overrides:

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

isEnabled

public final boolean isEnabled(EMFModule.Feature f)

Returns true if the current feature is used by the module.

Parameters:

f - feature

Returns:

true if used

getFeatures

public int getFeatures()

configure

public EMFModule configure(EMFModule.Feature feature,
                           boolean state)

Configures the module with one of possible Feature.

Parameters:

feature - feature

state - of feature

Returns:

EMFModule

setUriHandler

public void setUriHandler(URIHandler handler)

Tells the module which URIHandler to use to de/resolve URIs during de/serialization.

Parameters:

handler - use for de/serialization

getUriHandler

public URIHandler getUriHandler()

Returns the URIHandler that will be used to de/resolve URIs during de/serialization.

Returns:

handler

getIdentityInfo

public EcoreIdentityInfo getIdentityInfo()

getTypeInfo

public EcoreTypeInfo getTypeInfo()

getReferenceInfo

public EcoreReferenceInfo getReferenceInfo()