io.nem.symbol.sdk.model.transaction

Interface JsonHelper

All Known Implementing Classes:

JsonHelperGson, JsonHelperJackson2

public interface JsonHelper

JSON Helper interface used by the mappers to process json objects.

Mappers should use the statically typed open API generated DTOs when possible. This helper should be used when there is no way of just using the DTOs. For example when processing "anyOf" kind of attributes.

This interface hides the json underline implementation like gson or jackson2.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.Object object, java.lang.String... path) This method retrieves if there is a field/value for the given path.
<T> T	convert(java.lang.Object object, java.lang.Class<T> instanceClass, java.lang.String... path) It converts a object (for example a native json object or a map) into another type (like a statically type DTO).
java.math.BigInteger	getBigInteger(java.lang.Object object, java.lang.String... path) This method retrieves a BigInteger attribute following the the provided path
java.lang.Boolean	getBoolean(java.lang.Object object, java.lang.String... path) This method retrieves a Long attribute following the the provided path
java.lang.Integer	getInteger(java.lang.Object object, java.lang.String... path) This method retrieves a Integer attribute following the the provided path
java.lang.Long	getLong(java.lang.Object object, java.lang.String... path) This method retrieves a Long attribute following the the provided path
java.lang.Object	getObject(java.lang.Object object, java.lang.String... path) A generic object form the given payload.
java.lang.String	getString(java.lang.Object object, java.lang.String... path) This method retrieves a Long attribute following the the provided path
java.lang.Object	parse(java.lang.String string) It parse a json string into an object of the underlying implementation (e.g.
<T> T	parse(java.lang.String string, java.lang.Class<T> clazz) It parse a json string into a an object of the given class.
<T> java.util.List<T>	parseList(java.lang.String string, java.lang.Class<T> clazz) It parse a json string into an object list of the given class.
java.lang.String	prettyPrint(java.lang.Object object) It serializes an object into pretty json string.
java.lang.String	print(java.lang.Object object) It serializes an object into json.

Method Detail

print

java.lang.String print(java.lang.Object object)

It serializes an object into json.

Parameters:

object - the object (json native object, MAP or DTO)

Returns:

the string or null if the object is null.

prettyPrint

java.lang.String prettyPrint(java.lang.Object object)

It serializes an object into pretty json string.

Parameters:

object - the object (json native object, MAP or DTO)

Returns:

the string or null if the object is null.

parse

java.lang.Object parse(java.lang.String string)

It parse a json string into an object of the underlying implementation (e.g. gson JsonObject or jackson ObjectNode)

Parameters:

string - the json string

Returns:

the object or null if the string is null.

parseList

<T> java.util.List<T> parseList(java.lang.String string,
                                java.lang.Class<T> clazz)

It parse a json string into an object list of the given class.

Type Parameters:

T - the type of the parsed object

Parameters:

string - the json string

clazz - the class of the parsed object

Returns:

the object or null if the string is null.

parse

<T> T parse(java.lang.String string,
            java.lang.Class<T> clazz)

It parse a json string into a an object of the given class.

Type Parameters:

T - the type of the parsed object

Parameters:

string - the json string

clazz - the class of the parsed object

Returns:

the object or null if the string is null.

convert

<T> T convert(java.lang.Object object,
              java.lang.Class<T> instanceClass,
              java.lang.String... path)

It converts a object (for example a native json object or a map) into another type (like a statically type DTO).

This is usefull to convert opan api "anyOf" objects into a defined DTO.

Type Parameters:

T - he type of the converted object

Parameters:

object - the json object (like a json native object or a map)

instanceClass - the class of the converted object

path - the path

Returns:

the converted object o null if the object is null;

getInteger

java.lang.Integer getInteger(java.lang.Object object,
                             java.lang.String... path)

This method retrieves a Integer attribute following the the provided path

for example:

object = { "someAttribute1": {"someAttribute2": {"aNumber": 10} } }

getInteger(object,"someAttribute1","someAttribute2","aNumber") will return 10

Parameters:

object - the object

path - the path

Returns:

an Integer or null if the path doesn't exist or is null.

getLong

java.lang.Long getLong(java.lang.Object object,
                       java.lang.String... path)

This method retrieves a Long attribute following the the provided path

for example:

object = { "someAttribute1": {"someAttribute2": {"aNumber": 10} } }

getInteger(object,"someAttribute1","someAttribute2","aNumber") will return 10

Parameters:

object - the object

path - the path

Returns:

an Long or null if the path doesn't exist or is null.

getString

java.lang.String getString(java.lang.Object object,
                           java.lang.String... path)

This method retrieves a Long attribute following the the provided path

for example:

object = { "someAttribute1": {"someAttribute2": {"aString": "hello"} } }

getInteger(object,"someAttribute1","someAttribute2","aString") will return "hello"

Parameters:

object - the object

path - the path

Returns:

an Long or null if the path doesn't exist or is null.

getBoolean

java.lang.Boolean getBoolean(java.lang.Object object,
                             java.lang.String... path)

This method retrieves a Long attribute following the the provided path

for example:

object = { "someAttribute1": {"someAttribute2": {"aBoolean": true} } }

getInteger(object,"someAttribute1","someAttribute2","aBoolean") will return true

Parameters:

object - the object

path - the path

Returns:

an Long or null if the path doesn't exist or is null.

getBigInteger

java.math.BigInteger getBigInteger(java.lang.Object object,
                                   java.lang.String... path)

This method retrieves a BigInteger attribute following the the provided path

for example:

object = { "someAttribute1": {"someAttribute2": {"aBigInteger": "123"} } }

getBigInteger(object,"someAttribute1","someAttribute2","aBigInteger") will return 123

Parameters:

object - the object

path - the path

Returns:

a BigInteger or null if the path doesn't exist or is null.

contains

boolean contains(java.lang.Object object,
                 java.lang.String... path)

This method retrieves if there is a field/value for the given path.

Parameters:

object - the object

path - the path

Returns:

if there is a attribute set in the object following the giving path.

getObject

java.lang.Object getObject(java.lang.Object object,
                           java.lang.String... path)

A generic object form the given payload.

Parameters:

object - the object

path - the path

Returns:

a generic object for the fiven payload.