org.fujion.common

Class JSONUtil

java.lang.Object

org.fujion.common.JSONUtil

public class JSONUtil
extends Object

A set of static methods supporting serialization and deserialization of objects using the JSON format. This particular implementation uses the Jackson JSON library, but other JSON implementations could be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSONUtil.AsPropertyTypeSerializerEx Required to suppress writing of type information except for top-level objects.

Method Summary

Modifier and Type	Method and Description
static Object	deserialize(String data) Deserializes an object from JSON format.
static Object	deserialize(String typeProperty, String data) Deserializes an object from JSON format.
static <T> List<T>	deserializeList(String data, Class<T> clazz) Deserializes a list of objects.
static <T> List<T>	deserializeList(String typeProperty, String data, Class<T> clazz) Deserializes a list of objects.
static String	getAlias(Class<?> clazz) Returns an alias given its associated class.
static com.fasterxml.jackson.databind.ObjectMapper	getMapper() Returns an instance of the mapper for the default type property.
static com.fasterxml.jackson.databind.ObjectMapper	getMapper(String typeProperty) Returns an instance of the mapper for the specified type property.
static com.fasterxml.jackson.databind.JsonNode	merge(com.fasterxml.jackson.databind.JsonNode destNode, com.fasterxml.jackson.databind.JsonNode srcNode) Merges one JSON tree (srcNode) into another (destNode).
static com.fasterxml.jackson.databind.JsonNode	merge(com.fasterxml.jackson.databind.JsonNode destNode, com.fasterxml.jackson.databind.JsonNode srcNode, boolean deleteOnNull) Merges one JSON tree (srcNode) into another (destNode).
static void	registerAlias(String alias, Class<?> clazz) Register an alias for the specified class.
static String	serialize(Object object) Serializes an object to JSON format.
static String	serialize(Object object, boolean prettyPrint) Serializes an object to JSON format.
static String	serialize(String typeProperty, Object object) Serializes an object to JSON format.
static String	serialize(String typeProperty, Object object, boolean prettyPrint) Serializes an object to JSON format.
static void	setDateFormat(DateFormat dateFormat) Sets the date format to be used when serializing dates.
static void	setDateFormat(String typeProperty, DateFormat dateFormat) Sets the date format to be used when serializing dates.
static void	unregisterAlias(String name) Removes a registered alias.

Methods inherited from class java.lang.Object

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

Method Detail

getMapper

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

Returns an instance of the mapper for the default type property.

Returns:

A mapper.

getMapper

public static com.fasterxml.jackson.databind.ObjectMapper getMapper(String typeProperty)

Returns an instance of the mapper for the specified type property.

Parameters:

typeProperty - The name of the property signifying the data type.

Returns:

A mapper.

registerAlias

public static void registerAlias(String alias,
                                 Class<?> clazz)

Register an alias for the specified class. The alias will be used when serializing objects of this class. A given class or alias may only be registered once.

Parameters:

alias - Alias to be used for serialization.

clazz - Class to be associated with the alias.

unregisterAlias

public static void unregisterAlias(String name)

Removes a registered alias.

Parameters:

name - Alias to be unregistered.

getAlias

public static final String getAlias(Class<?> clazz)

Returns an alias given its associated class.

Parameters:

clazz - The class whose alias is sought.

Returns:

The alias associated with the specified class, or null if one does not exist.

setDateFormat

public static void setDateFormat(DateFormat dateFormat)

Sets the date format to be used when serializing dates.

Parameters:

dateFormat - Date format to use.

setDateFormat

public static void setDateFormat(String typeProperty,
                                 DateFormat dateFormat)

Sets the date format to be used when serializing dates.

Parameters:

typeProperty - The name of the property signifying the data type.

dateFormat - Date format to use.

serialize

public static String serialize(Object object)

Serializes an object to JSON format.

Parameters:

object - Object to be serialized.

Returns:

Serialized form of the object in JSON format.

serialize

public static String serialize(Object object,
                               boolean prettyPrint)

Serializes an object to JSON format.

Parameters:

object - Object to be serialized.

prettyPrint - If true, format output for display.

Returns:

Serialized form of the object in JSON format.

serialize

public static String serialize(String typeProperty,
                               Object object)

Serializes an object to JSON format.

Parameters:

typeProperty - The name of the property signifying the data type.

object - Object to be serialized.

Returns:

Serialized form of the object in JSON format.

serialize

public static String serialize(String typeProperty,
                               Object object,
                               boolean prettyPrint)

Serializes an object to JSON format.

Parameters:

typeProperty - The name of the property signifying the data type.

object - Object to be serialized.

prettyPrint - If true, format output for display.

Returns:

Serialized form of the object in JSON format.

deserialize

public static Object deserialize(String data)

Deserializes an object from JSON format.

Parameters:

data - Serialized form of the object.

Returns:

An instance of the deserialized object.

deserialize

public static Object deserialize(String typeProperty,
                                 String data)

Deserializes an object from JSON format.

Parameters:

typeProperty - The name of the property signifying the data type.

data - Serialized form of the object.

Returns:

An instance of the deserialized object.

deserializeList

public static <T> List<T> deserializeList(String data,
                                          Class<T> clazz)

Deserializes a list of objects.

Type Parameters:

T - The list elements' class.

Parameters:

data - Serialized form of the list in JSON format.

clazz - The class of objects found in the list.

Returns:

A list of objects of the specified type.

deserializeList

public static <T> List<T> deserializeList(String typeProperty,
                                          String data,
                                          Class<T> clazz)

Deserializes a list of objects.

Type Parameters:

T - The list elements' class.

Parameters:

typeProperty - The name of the property signifying the data type.

data - Serialized form of the list in JSON format.

clazz - The class of objects found in the list.

Returns:

A list of objects of the specified type.

merge

public static com.fasterxml.jackson.databind.JsonNode merge(com.fasterxml.jackson.databind.JsonNode destNode,
                                                            com.fasterxml.jackson.databind.JsonNode srcNode)

Merges one JSON tree (srcNode) into another (destNode).

Parameters:

destNode - The tree receiving the merged node.

srcNode - The tree supplying the nodes to merge.

Returns:

The destination node post merging.

merge

public static com.fasterxml.jackson.databind.JsonNode merge(com.fasterxml.jackson.databind.JsonNode destNode,
                                                            com.fasterxml.jackson.databind.JsonNode srcNode,
                                                            boolean deleteOnNull)

Merges one JSON tree (srcNode) into another (destNode).

Parameters:

destNode - The tree receiving the merged node.

srcNode - The tree supplying the nodes to merge.

deleteOnNull - If true and a null value is encountered in the source, delete the corresponding node in the destination. If false, null values are treated like any other value.

Returns:

The destination node post merging.