Caplin.DataSource.IJsonHandler Interface Reference

Inheritance diagram for Caplin.DataSource.IJsonHandler:

Public Member Functions
object	Diff (object source, object target)
String	Format (object jsonTree)
object	Parse (String jsonText)
object	Patch (object source, object jsonPatch)
object	ToJsonTree (Object pojo)
T	ToObject< T > (object jsonTree, T userType)

Detailed Description

Handler for parsing, patching and serializing Objects to JSON

JsonTreeType the type of the internal tree structure used by the underlying JSON library

Member Function Documentation

object Caplin.DataSource.IJsonHandler.Diff	(	object	source,
		object	target
	)

Creates a JSON patch of the difference between two JSON tree representations

Parameters

source	a JSON tree representation of the source object
target	a JSON tree representation of the target object

Returns

a JSON tree representation of the JSON patch needed to patch source to create target.

Exceptions

Exception

if the difference operation fails

Implemented in Caplin.DataSource.Messaging.JSON.NativeJsonHandler.

String Caplin.DataSource.IJsonHandler.Format

(

object

jsonTree

)

Formats a JSON tree representation of an object to a JSON String.

Parameters

jsonTree

a JSON tree representation of an object

Returns

the JSON String

Exceptions

Exception

if formatting fails

Implemented in Caplin.DataSource.Messaging.JSON.NativeJsonHandler.

object Caplin.DataSource.IJsonHandler.Parse

(

String

jsonText

)

Parses a JSON text into a JSON tree representation used by the underlying JSON library.

Parameters

jsonText

the JSON text to parse

Returns

a JSON tree representation of the JSON text

Exceptions

Exception

if the parsing fails

object Caplin.DataSource.IJsonHandler.Patch	(	object	source,
		object	jsonPatch
	)

Updates a JSON tree representation with a JSON patch

Parameters

source	a JSON tree representation of the source object
jsonPatch	a JSON tree representation of the JSON patch

Returns

the updated, patched object

Exceptions

Exception

if the patch fails

Implemented in Caplin.DataSource.Messaging.JSON.NativeJsonHandler.

object Caplin.DataSource.IJsonHandler.ToJsonTree

(

Object

pojo

)

Serializes a plain Java object (POJO) to a JSON tree representation used by the underlying JSON library.

Parameters

pojo	a plain Java object

Returns

a JSON tree representation of the object

Exceptions

Exception

if conversion fails

T Caplin.DataSource.IJsonHandler.ToObject< T >	(	object	jsonTree,
		T	userType
	)

Deserializes a JSON tree representation to a plain Java object

Parameters

jsonTree	a JSON tree representation of the object
userType	the type of the object to deserialize into

Returns

a new object of type userType

Exceptions

Exception

if deserialization fails

Implemented in Caplin.DataSource.Messaging.JSON.NativeJsonHandler.