com.elasticpath.xpf.connectivity.serialization

Class XPFJSONSerializationHelper

java.lang.Object

com.elasticpath.xpf.connectivity.serialization.XPFJSONSerializationHelper

public final class XPFJSONSerializationHelper
extends Object

Helper for serializing and deserializing objects to/from JSON using Jackson. Supports skipping fields/methods annotated with @LazyLoaded and @SkipSerialization when marshalling.

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper(Set<SerializationScope> scopes) Returns an ObjectMapper for the given set of scopes.
static String	marshalToJSON(Object objectToSerialize, Set<SerializationScope> scopes) Serializes the given object to JSON, skipping fields whose @SkipSerialization scopes intersect with the provided scopes set.
static <T> T	unmarshalFromJSON(String json, Class<T> clazz) Deserializes the given JSON string to specified class.
static <T> T	unmarshalFromJSON(String json, com.fasterxml.jackson.databind.JavaType javaType) Deserializes the given JSON string to the specified JavaType.
static <T> T	unmarshalFromJSON(String json, com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Deserializes the given JSON string to the specified TypeReference type.

Methods inherited from class java.lang.Object

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

Method Detail

getObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper(Set<SerializationScope> scopes)

Returns an ObjectMapper for the given set of scopes.

Parameters:

scopes - the serialization scopes

Returns:

the ObjectMapper

marshalToJSON

public static String marshalToJSON(Object objectToSerialize,
                                   Set<SerializationScope> scopes)

Serializes the given object to JSON, skipping fields whose @SkipSerialization scopes intersect with the provided scopes set.

Parameters:

objectToSerialize - the object to serialize

scopes - the scopes to skip

Returns:

the JSON string

unmarshalFromJSON

public static <T> T unmarshalFromJSON(String json,
                                      Class<T> clazz)

Deserializes the given JSON string to specified class.

Type Parameters:

T - the type of the deserialized entity

Parameters:

json - the JSON string

clazz - the class to deserialize to

Returns:

the deserialized entity

unmarshalFromJSON

public static <T> T unmarshalFromJSON(String json,
                                      com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

Deserializes the given JSON string to the specified TypeReference type.

Type Parameters:

T - the type of the deserialized entity

Parameters:

json - the JSON string

typeReference - the type reference

Returns:

the deserialized entity

unmarshalFromJSON

public static <T> T unmarshalFromJSON(String json,
                                      com.fasterxml.jackson.databind.JavaType javaType)

Deserializes the given JSON string to the specified JavaType.

Type Parameters:

T - the type of the deserialized entity

Parameters:

json - the JSON string

javaType - the type reference

Returns:

the deserialized entity