org.conqat.engine.commons.util

Class JsonUtils

java.lang.Object

org.conqat.engine.commons.util.JsonUtils

public class JsonUtils
extends java.lang.Object

Utility code for dealing with JSON. This uses Jackson for serialization and deserialization to JSON.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonUtils.JsonDeserializationException Wrapper exception for JsonProcessingException as the other is a checked exception and we don't want to check it everywhere.
static class	JsonUtils.JsonSerializationException Wrapper exception for JsonProcessingException as the other is a checked exception and we don't want to check it everywhere.

Constructor Summary

Constructors

Constructor and Description
JsonUtils()

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.JsonNode	deserializeFromJson(java.lang.String json) Deserializes a JSON string into a JsonNode.
static <T> T	deserializeFromJson(java.lang.String json, java.lang.Class<T> expectedClass) Deserializes a JSON string.
static <T> T	deserializeFromJson(java.lang.String json, com.fasterxml.jackson.databind.JavaType expectedType) Deserializes a JSON string.
static <T> T	deserializeFromJson(java.lang.String json, com.fasterxml.jackson.core.type.TypeReference<T> expectedType) Deserializes a JSON string.
static <T> T	deserializeFromJsonWithNullCheck(java.lang.String json, java.lang.Class<T> expectedClass) Deserializes a JSON string.
static <T> com.fasterxml.jackson.databind.JavaType	getJavaListType(java.lang.Class<T> resultClass)
static <T> com.fasterxml.jackson.databind.JavaType	getJavaType(java.lang.Class<T> resultClass)
static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
static java.util.Optional<com.fasterxml.jackson.databind.JsonNode>	getWithCapitalizedOrLowercaseKey(com.fasterxml.jackson.databind.JsonNode jsonNode, java.lang.String key) Returns the json value or null for the given key, while trying 1.
static boolean	isNotSerialized(java.lang.reflect.Field field)
static boolean	isValidJson(java.lang.String json) Returns whether a string is a valid json or not.
static java.lang.String	prettyPrintJSON(java.lang.String json) Reformats a JSON string to be pretty printed.
static java.lang.String	serializeToJSON(java.lang.Object object) Serializes the given object to JSON.
static byte[]	serializeToJSONByteArray(java.lang.Object object) Serializes the given object to JSON as UTF-8 encoded byte array.
static java.lang.String	serializeToJSONPrettyPrinted(java.lang.Object object) Reformats a JSON string to be pretty printed.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonUtils

public JsonUtils()

Method Detail

serializeToJSON

public static java.lang.String serializeToJSON(java.lang.Object object)

Serializes the given object to JSON.

serializeToJSONByteArray

public static byte[] serializeToJSONByteArray(java.lang.Object object)

Serializes the given object to JSON as UTF-8 encoded byte array.

getObjectMapper

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

See Also:

OBJECT_MAPPER

getJavaType

public static <T> com.fasterxml.jackson.databind.JavaType getJavaType(java.lang.Class<T> resultClass)

getJavaListType

public static <T> com.fasterxml.jackson.databind.JavaType getJavaListType(java.lang.Class<T> resultClass)

deserializeFromJson

public static <T> T deserializeFromJson(java.lang.String json,
                                        java.lang.Class<T> expectedClass)
                                 throws ConQATException

Deserializes a JSON string.

Throws:

ConQATException - if the input string could not be parsed as JSON or the class is not constructible.

deserializeFromJson

public static <T> T deserializeFromJson(java.lang.String json,
                                        com.fasterxml.jackson.core.type.TypeReference<T> expectedType)
                                 throws ConQATException

Deserializes a JSON string.

Throws:

ConQATException - if the input string could not be parsed as JSON or the class is not constructible.

deserializeFromJson

public static <T> T deserializeFromJson(java.lang.String json,
                                        com.fasterxml.jackson.databind.JavaType expectedType)
                                 throws ConQATException

Deserializes a JSON string.

Throws:

ConQATException - if the input string could not be parsed as JSON or the class is not constructible.

deserializeFromJson

public static com.fasterxml.jackson.databind.JsonNode deserializeFromJson(java.lang.String json)
                                                                   throws ConQATException

Deserializes a JSON string into a JsonNode.

Throws:

ConQATException - if the input string could not be parsed as JSON or the class is not constructible.

deserializeFromJsonWithNullCheck

public static <T> T deserializeFromJsonWithNullCheck(java.lang.String json,
                                                     java.lang.Class<T> expectedClass)
                                              throws ConQATException

Deserializes a JSON string. Throws an error if the resulting object is null or contains an attribute that is null.

Throws:

ConQATException - if the input string could not be parsed as JSON, or the class is not constructible, or the resulting object or one of its attributes would be null.

getWithCapitalizedOrLowercaseKey

public static java.util.Optional<com.fasterxml.jackson.databind.JsonNode> getWithCapitalizedOrLowercaseKey(com.fasterxml.jackson.databind.JsonNode jsonNode,
                                                                                                           java.lang.String key)

Returns the json value or null for the given key, while trying 1. a lowercase version of the key (e.g. 'project'), and 2. a capitalized version of the lowercase key ('Project');

isValidJson

public static boolean isValidJson(java.lang.String json)

Returns whether a string is a valid json or not.

prettyPrintJSON

public static java.lang.String prettyPrintJSON(java.lang.String json)
                                        throws ConQATException

Reformats a JSON string to be pretty printed.

Throws:

ConQATException

serializeToJSONPrettyPrinted

public static java.lang.String serializeToJSONPrettyPrinted(java.lang.Object object)
                                                     throws ConQATException

Reformats a JSON string to be pretty printed.

Throws:

ConQATException

isNotSerialized

public static boolean isNotSerialized(java.lang.reflect.Field field)

Returns:

whether the given field is not serialized, i.e. skipped in JSON responses to the client.