me.lucko.helper.gson

Interface GsonSerializable

All Known Subinterfaces:

Cooldown, Hologram

All Known Implementing Classes:

BlockPosition, BlockRegion, ChunkPosition, ChunkRegion, CircularRegion, Direction, Point, Position, Region, Tps, VectorPoint

public interface GsonSerializable

An object which can be serialized to JSON.

Classes which implement this interface should also implement a static "deserialize" method, accepting JsonElement as the only parameter.

Method Summary

Modifier and Type	Method and Description
static <T extends GsonSerializable> T	deserialize(Class<T> clazz, com.google.gson.JsonElement element) Deserializes a JsonElement to a GsonSerializable object.
static GsonSerializable	deserializeRaw(Class<?> clazz, com.google.gson.JsonElement element) Deserializes a JsonElement to a GsonSerializable object.
static Method	getDeserializeMethod(Class<?> clazz) Gets the deserialization method for a given class.
com.google.gson.JsonElement	serialize() Serializes the object to JSON

Method Detail

deserialize

@Nonnull
static <T extends GsonSerializable> T deserialize(@Nonnull
                                                           Class<T> clazz,
                                                           @Nonnull
                                                           com.google.gson.JsonElement element)

Deserializes a JsonElement to a GsonSerializable object.

Type Parameters:

T - the GsonSerializable type

Parameters:

clazz - the GsonSerializable class

element - the json element to deserialize

Returns:

the deserialized object

Throws:

IllegalStateException - if the clazz does not have a deserialization method

deserializeRaw

@Nonnull
static GsonSerializable deserializeRaw(@Nonnull
                                                Class<?> clazz,
                                                @Nonnull
                                                com.google.gson.JsonElement element)

Deserializes a JsonElement to a GsonSerializable object.

Parameters:

clazz - the GsonSerializable class

element - the json element to deserialize

Returns:

the deserialized object

Throws:

IllegalStateException - if the clazz does not have a deserialization method

getDeserializeMethod

@Nullable
static Method getDeserializeMethod(@Nonnull
                                             Class<?> clazz)

Gets the deserialization method for a given class.

Parameters:

clazz - the class

Returns:

the deserialization method, if the class has one

serialize

@Nonnull
com.google.gson.JsonElement serialize()

Serializes the object to JSON

Returns:

a json form of this object