Package com.jeff_media.jsonconfigurationserialization

Class JsonConfigurationSerialization

java.lang.Object

com.jeff_media.jsonconfigurationserialization.JsonConfigurationSerialization

public final class JsonConfigurationSerialization
extends Object

Utility class for serializing and deserializing ConfigurationSerializables to and from Json

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigurationSerializableTypeHierarchyAdapter	TYPE_HIERARCHY_ADAPTER	A JsonSerializer and JsonDeserializer for ConfigurationSerializables to be used with GsonBuilder.registerTypeHierarchyAdapter(Class, Object)

Method Summary

Modifier and Type	Method	Description
static ConfigurationSerializable	deserialize(String json)	Deserializes a ConfigurationSerializable from a Json String
static <T extends ConfigurationSerializable> T	deserialize(String json, Class<T> clazz)	Deserializes a ConfigurationSerializable from a Json String
static String	serialize(ConfigurationSerializable serializable)	Serializes a ConfigurationSerializable to a Json String

Methods inherited from class java.lang.Object

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

Field Details

TYPE_HIERARCHY_ADAPTER

public static final ConfigurationSerializableTypeHierarchyAdapter TYPE_HIERARCHY_ADAPTER

A JsonSerializer and JsonDeserializer for ConfigurationSerializables to be used with GsonBuilder.registerTypeHierarchyAdapter(Class, Object)

Method Details

serialize

public static String serialize(ConfigurationSerializable serializable)

Serializes a ConfigurationSerializable to a Json String

Parameters:

serializable - ConfigurationSerializable to serialize

Returns:

Json String

deserialize

public static ConfigurationSerializable deserialize(String json)
                                             throws IllegalArgumentException

Deserializes a ConfigurationSerializable from a Json String

Parameters:

json - Json String

Returns:

deserialized ConfigurationSerializable

Throws:

IllegalArgumentException - if the Json String is invalid or if the ConfigurationSerializable class is not found

deserialize

public static <T extends ConfigurationSerializable>
T deserialize(String json,
 Class<T> clazz)
       throws IllegalArgumentException,
ClassCastException

Deserializes a ConfigurationSerializable from a Json String

Parameters:

json - Json String

clazz - Class of the ConfigurationSerializable

Returns:

deserialized ConfigurationSerializable

Throws:

IllegalArgumentException - if the Json String is invalid or if the ConfigurationSerializable class is not found

ClassCastException - if the ConfigurationSerializable is not of the specified class