Package org.apache.wayang.core.util

Class JsonSerializables

java.lang.Object

org.apache.wayang.core.util.JsonSerializables

public class JsonSerializables
extends Object

Utility to deal with JsonSerializables.

Constructor Summary

Constructors

Constructor	Description
JsonSerializables()

Method Summary

Modifier and Type	Method	Description
static WayangJsonObj	addClassTag(Object obj, WayangJsonObj wayangJsonObj)	Tag the WayangJsonObj with the Class of the other Object.
static WayangJsonObj	addClassTag(Object obj, WayangJsonObj wayangJsonObj, boolean isAddClassTag)	Optionally tag the WayangJsonObj with the Class of the other Object.
static Object	deserialize(Object json)	Deserialize a given JSON datatype.
static <T> T	deserialize(WayangJsonObj wayangJsonObj)	Deserialize a Class-tagged WayangJsonObj that should correspond to a JsonSerializable.
static <T> T	deserialize(WayangJsonObj wayangJsonObj, Class<? extends T> cls)	Deserialize a WayangJsonObj that should correspond to a JsonSerializable.
static <T> T	deserialize(WayangJsonObj wayangJsonObj, JsonSerializer<T> serializer)	Deserialize a (Class-tagged) WayangJsonObj with a JsonSerializer.
static <T> T	deserialize(WayangJsonObj wayangJsonObj, JsonSerializer<T> serializer, Class<? extends T> cls)	Deserialize a WayangJsonObj with a JsonSerializer.
static <T> List<T>	deserializeAllAsList(WayangJsonArray wayangJsonArray)	Deserialize a WayangJsonArray according to the rules of deserialize(Object).
static <T> List<T>	deserializeAllAsList(WayangJsonArray wayangJsonArray, Class<T> cls)	Deserialize a WayangJsonArray according to the rules of deserialize(WayangJsonObj, Class).
static <T> List<T>	deserializeAllAsList(WayangJsonArray wayangJsonArray, JsonSerializer<T> serializer)	Deserialize a WayangJsonArray according to the rules of deserialize(WayangJsonObj, JsonSerializer).
static <T> List<T>	deserializeAllAsList(WayangJsonArray wayangJsonArray, JsonSerializer<T> serializer, Class<T> cls)	Deserialize a WayangJsonArray according to the rules of deserialize(WayangJsonObj, JsonSerializer, Class).
static Class<?>	getClassTag(WayangJsonObj wayangJsonObj)	Read and load the specified Class in a WayangJsonObj.
static boolean	isJsonCompatible(Object obj)	Tells whether the given instance is a JSON datatype.
static boolean	isJsonNull(Object obj)	Tells whether the given instance is a (JSON) null value.
static boolean	isUnconvertedInstance(Object obj)	Tells whether the given instance does not require conversion, which is the case for Longs, Integers, Doubles, Strings, and nulls.
static Object	serialize(Object obj, boolean isPolymorph)	Try to serialize the given Object.
static WayangJsonObj	serialize(JsonSerializable serializable, boolean isPolymorph)	Serialize the given JsonSerializable.
static <T> WayangJsonObj	serialize(T obj, boolean isPolymorph, JsonSerializer<T> serializer)	Serialize the given Object using a specific JsonSerializer.
static WayangJsonArray	serializeAll(Collection<?> collection, boolean isPolymorph)	Try to serialize the given Objects.
static <T> WayangJsonArray	serializeAll(Collection<T> collection, boolean isPolymorph, JsonSerializer<T> serializer)	Serialize the given Objects using a specific JsonSerializer.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonSerializables

public JsonSerializables()

Method Details

serialize

public static Object serialize(Object obj,
 boolean isPolymorph)

Try to serialize the given Object. It must be JSON-compatible or a JsonSerializable.

Parameters:

obj - the Object to serialize

isPolymorph - in case a WayangJsonObj is created, whether it should be tagged with the Class of obj

Returns:

the serialization result

See Also:

• isJsonCompatible(Object)

serialize

public static WayangJsonObj serialize(JsonSerializable serializable,
 boolean isPolymorph)

Serialize the given JsonSerializable.

Parameters:

serializable - the JsonSerializable to serialize

isPolymorph - in case a WayangJsonObj is created, whether it should be tagged with the Class of serializable

Returns:

the serialization result

serialize

public static <T> WayangJsonObj serialize(T obj,
 boolean isPolymorph,
 JsonSerializer<T> serializer)

Serialize the given Object using a specific JsonSerializer.

Parameters:

obj - the Object to serialize

isPolymorph - in case a WayangJsonObj is created, whether it should be tagged with the Class of serializable

serializer - the JsonSerializer

Returns:

the serialization result

serializeAll

public static WayangJsonArray serializeAll(Collection<?> collection,
 boolean isPolymorph)

Try to serialize the given Objects. They must be JSON-compatible or a JsonSerializables.

Parameters:

collection - the Objects to serialize

isPolymorph - in case a WayangJsonObj is created, whether it should be tagged with the Class of the according Object

Returns:

the serialization result

See Also:

• isJsonCompatible(Object)

serializeAll

public static <T> WayangJsonArray serializeAll(Collection<T> collection,
 boolean isPolymorph,
 JsonSerializer<T> serializer)

Serialize the given Objects using a specific JsonSerializer.

Parameters:

collection - the Objects to serialize

isPolymorph - in case a WayangJsonObj is created, whether it should be tagged with the Class of serializable

serializer - the JsonSerializer

Returns:

the serialization result

deserialize

public static Object deserialize(Object json)

Deserialize a given JSON datatype. The following cases are supported:

• json is a (JSON) null value;
• json is a basic (JSON) datatype;
• json is a Class-tagged WayangJsonObj that corresponds to a JsonSerializable;
• json is a WayangJsonArray with Class-tagged WayangJsonObjs that correspond to a JsonSerializables - in this case, the result type is a List.

Parameters:

json - the JSON data

Returns:

the deserialization result

deserialize

public static <T> T deserialize(WayangJsonObj wayangJsonObj)

Deserialize a Class-tagged WayangJsonObj that should correspond to a JsonSerializable.

Parameters:

wayangJsonObj - the WayangJsonObj

Returns:

the deserialization product

deserialize

public static <T> T deserialize(WayangJsonObj wayangJsonObj,
 Class<? extends T> cls)

Deserialize a WayangJsonObj that should correspond to a JsonSerializable.

Parameters:

wayangJsonObj - the WayangJsonObj

cls - the Class of the deserialization product

Returns:

the deserialization product

deserialize

public static <T> T deserialize(WayangJsonObj wayangJsonObj,
 JsonSerializer<T> serializer)

Deserialize a (Class-tagged) WayangJsonObj with a JsonSerializer.

Parameters:

wayangJsonObj - the WayangJsonObj

serializer - the JsonSerializer

Returns:

the deserialization product

deserialize

public static <T> T deserialize(WayangJsonObj wayangJsonObj,
 JsonSerializer<T> serializer,
 Class<? extends T> cls)

Deserialize a WayangJsonObj with a JsonSerializer.

Parameters:

wayangJsonObj - the WayangJsonObj

serializer - the JsonSerializer

cls - the Class of the deserialization product

Returns:

the deserialization product

deserializeAllAsList

public static <T> List<T> deserializeAllAsList(WayangJsonArray wayangJsonArray)

Deserialize a WayangJsonArray according to the rules of deserialize(Object).

Parameters:

wayangJsonArray - the WayangJsonArray

Returns:

the deserialization product

deserializeAllAsList

public static <T> List<T> deserializeAllAsList(WayangJsonArray wayangJsonArray,
 Class<T> cls)

Deserialize a WayangJsonArray according to the rules of deserialize(WayangJsonObj, Class).

Parameters:

wayangJsonArray - the WayangJsonArray

cls - the Class of the elements in the jsonArray

Returns:

the deserialization product

deserializeAllAsList

public static <T> List<T> deserializeAllAsList(WayangJsonArray wayangJsonArray,
 JsonSerializer<T> serializer)

Deserialize a WayangJsonArray according to the rules of deserialize(WayangJsonObj, JsonSerializer).

Parameters:

wayangJsonArray - the WayangJsonArray

serializer - the JsonSerializer

Returns:

the deserialization product

deserializeAllAsList

public static <T> List<T> deserializeAllAsList(WayangJsonArray wayangJsonArray,
 JsonSerializer<T> serializer,
 Class<T> cls)

Deserialize a WayangJsonArray according to the rules of deserialize(WayangJsonObj, JsonSerializer, Class).

Parameters:

wayangJsonArray - the WayangJsonArray

serializer - the JsonSerializer

cls - the Class of the elements in the jsonArray

Returns:

the deserialization product

addClassTag

public static WayangJsonObj addClassTag(Object obj,
 WayangJsonObj wayangJsonObj)

Tag the WayangJsonObj with the Class of the other Object.

Parameters:

obj - whose Class should be tagged

wayangJsonObj - that should be tagged

Returns:

the jsonObject

addClassTag

public static WayangJsonObj addClassTag(Object obj,
 WayangJsonObj wayangJsonObj,
 boolean isAddClassTag)

Optionally tag the WayangJsonObj with the Class of the other Object.

Parameters:

obj - whose Class should be tagged

wayangJsonObj - that should be tagged

isAddClassTag - if this is false, no action will be performed

Returns:

the jsonObject

getClassTag

public static Class<?> getClassTag(WayangJsonObj wayangJsonObj)
                            throws ClassNotFoundException

Read and load the specified Class in a WayangJsonObj.

Parameters:

wayangJsonObj - that contains the Class tag

Returns:

the loaded Class or null if none exists

Throws:

ClassNotFoundException - if the Class could not be loaded

isJsonNull

public static boolean isJsonNull(Object obj)

Tells whether the given instance is a (JSON) null value.

Parameters:

obj - the instance to test

Returns:

whether obj is a (JSON) null value

isJsonCompatible

public static boolean isJsonCompatible(Object obj)

Tells whether the given instance is a JSON datatype.

Parameters:

obj - the instance to test

Returns:

whether obj is a JSON datatype

isUnconvertedInstance

public static boolean isUnconvertedInstance(Object obj)

Tells whether the given instance does not require conversion, which is the case for Longs, Integers, Doubles, Strings, and nulls.

Parameters:

obj - the instance to test

Returns:

whether obj does not require conversion