Package io.github.classgraph.json

Class JSONDeserializer

java.lang.Object

io.github.classgraph.json.JSONDeserializer

public class JSONDeserializer
extends Object

Fast, lightweight Java object to JSON serializer, and JSON to Java object deserializer. Handles cycles in the object graph by inserting reference ids.

Constructor Summary

Constructors

Constructor	Description
JSONDeserializer()

Method Summary

Modifier and Type	Method	Description
static <T> T	deserializeObject(Class<T> expectedType, String json)	Deserialize JSON to a new object graph, with the root object of the specified expected type.
static void	deserializeToField(Object containingObject, String fieldName, String json)	Deserialize JSON to a new object graph, with the root object of the specified expected type, and store the root object in the named field of the given containing object.
static void	deserializeToField(Object containingObject, String fieldName, String json, io.github.classgraph.json.ClassFieldCache classFieldCache)	Deserialize JSON to a new object graph, with the root object of the specified expected type, and store the root object in the named field of the given containing object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONDeserializer

public JSONDeserializer()

Method Detail

deserializeObject

public static <T> T deserializeObject(Class<T> expectedType,
                                      String json)
                               throws IllegalArgumentException

Deserialize JSON to a new object graph, with the root object of the specified expected type. Does not work for generic types, since it is not possible to obtain the generic type of a Class reference.

Type Parameters:

T - The type that the JSON should conform to.

Parameters:

expectedType - The class reference for the type that the JSON should conform to.

json - the JSON string to deserialize.

Returns:

The object graph after deserialization.

Throws:

IllegalArgumentException - If anything goes wrong during deserialization.

deserializeToField

public static void deserializeToField(Object containingObject,
                                      String fieldName,
                                      String json,
                                      io.github.classgraph.json.ClassFieldCache classFieldCache)
                               throws IllegalArgumentException

Deserialize JSON to a new object graph, with the root object of the specified expected type, and store the root object in the named field of the given containing object. Works for generic types, since it is possible to obtain the generic type of a field.

Parameters:

containingObject - The object containing the named field to deserialize the object graph into.

fieldName - The name of the field to set with the result.

json - the JSON string to deserialize.

classFieldCache - The class field cache. Reusing this cache will increase the speed if many JSON documents of the same type need to be parsed.

Throws:

IllegalArgumentException - If anything goes wrong during deserialization.

deserializeToField

public static void deserializeToField(Object containingObject,
                                      String fieldName,
                                      String json)
                               throws IllegalArgumentException

Deserialize JSON to a new object graph, with the root object of the specified expected type, and store the root object in the named field of the given containing object. Works for generic types, since it is possible to obtain the generic type of a field.

Parameters:

containingObject - The object containing the named field to deserialize the object graph into.

fieldName - The name of the field to set with the result.

json - the JSON string to deserialize.

Throws:

IllegalArgumentException - If anything goes wrong during deserialization.