org.swat.json.utils

Class JsonUtilFX

java.lang.Object

org.swat.json.utils.JsonUtilFX

All Implemented Interfaces:

JsonUtil

public class JsonUtilFX
extends Object
implements JsonUtil

The Utilities for Json. In encapsulates ObjectMapper and provides additional method to deal with Json It is immutable

Author:

Swatantra Agrawal on 27-AUG-2017

Constructor Summary

Constructors

Constructor and Description
JsonUtilFX() Instantiates a new Json util.
JsonUtilFX(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Instantiates a new Json util.

Method Summary

Modifier and Type	Method and Description
JsonUtilFX	configure(com.fasterxml.jackson.databind.SerializationFeature serializationFeature, boolean state) Configure json util.
com.fasterxml.jackson.databind.ObjectMapper	getOBJECT_MAPPER() Gets a copy of object mapper.
String	pretty(Object object) Returns prettified json of the object
<T> List<T>	readList(InputStream stream, Class<T> clazz) Parses the json to List of desired type
<T> List<T>	readList(String json, Class<T> clazz) Parses the json to List of desired type
<K,V> Map<K,V>	readMap(String json, Class<K> keyClass, Class<V> valueClass) Parses the json to Map of desired type
<T> T	readObject(InputStream jsonStream, Class<T> clazz) Parses the json to desired type
<T> T	readObject(String json, Class<T> clazz) Reads json as Object
JsonUtil	registerModules(com.fasterxml.jackson.databind.Module... modules) Register modules json util.
JsonUtilFX	setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include inclusion) Set serialization inclusion json util.
String	toJsonString(Object object) Method convert to json string for the input object

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonUtilFX

public JsonUtilFX()

Instantiates a new Json util.

JsonUtilFX

public JsonUtilFX(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Instantiates a new Json util.

Parameters:

objectMapper - the object mapper

Method Detail

configure

public JsonUtilFX configure(com.fasterxml.jackson.databind.SerializationFeature serializationFeature,
                            boolean state)

Configure json util.

Parameters:

serializationFeature - the serialization feature

state - the state

Returns:

the json util

setSerializationInclusion

public JsonUtilFX setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include inclusion)

Set serialization inclusion json util.

Parameters:

inclusion - the inclusion

Returns:

the json util

registerModules

public JsonUtil registerModules(com.fasterxml.jackson.databind.Module... modules)

Register modules json util.

Parameters:

modules - the modules

Returns:

the json util

readObject

public <T> T readObject(InputStream jsonStream,
                        Class<T> clazz)
                 throws CoreRtException

Description copied from interface: JsonUtil

Parses the json to desired type

Specified by:

readObject in interface JsonUtil

Type Parameters:

T - Generics

Parameters:

jsonStream - The input stream

clazz - The Object type

Returns:

The parsed Object.

Throws:

CoreRtException - in case of any Exception

readList

public <T> List<T> readList(InputStream stream,
                            Class<T> clazz)
                     throws CoreRtException

Description copied from interface: JsonUtil

Parses the json to List of desired type

Specified by:

readList in interface JsonUtil

Type Parameters:

T - Generics

Parameters:

stream - The JSON stream

clazz - The Object type

Returns:

The parsed List.

Throws:

CoreRtException - in case of any Exception

getOBJECT_MAPPER

public com.fasterxml.jackson.databind.ObjectMapper getOBJECT_MAPPER()

Gets a copy of object mapper.

Returns:

the object mapper

readList

public <T> List<T> readList(String json,
                            Class<T> clazz)
                     throws CoreRtException

Description copied from interface: JsonUtil

Parses the json to List of desired type

Specified by:

readList in interface JsonUtil

Type Parameters:

T - Generics

Parameters:

json - The JSON

clazz - The Object type

Returns:

The parsed List.

Throws:

CoreRtException - in case of any Exception

readMap

public <K,V> Map<K,V> readMap(String json,
                              Class<K> keyClass,
                              Class<V> valueClass)
                       throws CoreRtException

Description copied from interface: JsonUtil

Parses the json to Map of desired type

Specified by:

readMap in interface JsonUtil

Type Parameters:

K - Generics

V - Generics

Parameters:

json - The JSON

keyClass - The Key Type

valueClass - The Value Type

Returns:

The parsed Map.

Throws:

CoreRtException - in case of any Exception

toJsonString

public String toJsonString(Object object)
                    throws CoreRtException

Description copied from interface: JsonUtil

Method convert to json string for the input object

Specified by:

toJsonString in interface JsonUtil

Parameters:

object - Object - The input object

Returns:

String - The output json string

Throws:

CoreRtException - in case of any Exception

readObject

public <T> T readObject(String json,
                        Class<T> clazz)
                 throws CoreRtException

Description copied from interface: JsonUtil

Reads json as Object

Specified by:

readObject in interface JsonUtil

Type Parameters:

T - Generics

Parameters:

json - The json

clazz - The class of Object

Returns:

The object

Throws:

CoreRtException - in case of any Exception

pretty

public String pretty(Object object)
              throws CoreRtException

Description copied from interface: JsonUtil

Returns prettified json of the object

Specified by:

pretty in interface JsonUtil

Parameters:

object - The object

Returns:

The prettified json

Throws:

CoreRtException - in case of any Exception