io.github.ageofwar.telejam.json

Class Json

java.lang.Object

io.github.ageofwar.telejam.json.Json

public final class Json
extends java.lang.Object

Utility class for JSON serialization and deserialization.

Method Summary

Modifier and Type	Method and Description
static <T> T	fromJson(java.io.Reader json, java.lang.Class<T> classOfT) This method deserializes the Json read from the specified reader into an object of the specified class.
static <T> T	fromJson(java.io.Reader json, java.lang.reflect.Type typeOfT) This method deserializes the Json read from the specified reader into an object of the specified type.
static <T> T	fromJson(java.lang.String json, java.lang.Class<T> classOfT) This method deserializes the specified Json into an object of the specified class.
static <T> T	fromJson(java.lang.String json, java.lang.reflect.Type typeOfT) This method deserializes the specified Json into an object of the specified type.
static java.lang.reflect.Type	genericTypeOf(java.lang.Class<?> rawType, java.lang.reflect.Type... typeArguments) Returns a new parameterized type, applying typeArguments to rawType.
static java.lang.String	toJson(java.lang.Object src) This method serializes the specified object into its equivalent Json representation.
static void	toJson(java.lang.Object src, java.lang.Appendable writer) This method serializes the specified object into its equivalent Json representation.
static java.lang.String	toJson(java.lang.Object src, java.lang.reflect.Type typeOfSrc) This method serializes the specified object, including those of generic types, into its equivalent Json representation.
static void	toJson(java.lang.Object src, java.lang.reflect.Type typeOfSrc, java.lang.Appendable writer) This method serializes the specified object, including those of generic types, into its equivalent Json representation.
static java.lang.String	toPrettyJson(java.lang.Object src) This method serializes the specified object into its equivalent Json representation.
static void	toPrettyJson(java.lang.Object src, java.lang.Appendable writer) This method serializes the specified object into its equivalent Json representation.
static java.lang.String	toPrettyJson(java.lang.Object src, java.lang.reflect.Type typeOfSrc) This method serializes the specified object, including those of generic types, into its equivalent Json representation.
static void	toPrettyJson(java.lang.Object src, java.lang.reflect.Type typeOfSrc, java.lang.Appendable writer) This method serializes the specified object, including those of generic types, into its equivalent Json representation.

Methods inherited from class java.lang.Object

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

Method Detail

toJson

public static java.lang.String toJson(java.lang.Object src)

This method serializes the specified object into its equivalent Json representation. This method should be used when the specified object is not a generic type. This method uses Object.getClass() to get the type for the specified object, but the getClass() loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, use toJson(Object, Type) instead. If you want to write out the object to a Writer, use toJson(Object, Appendable) instead.

Parameters:

src - the object for which Json representation is to be created

Returns:

Json representation of src.

toJson

public static java.lang.String toJson(java.lang.Object src,
                                      java.lang.reflect.Type typeOfSrc)

This method serializes the specified object, including those of generic types, into its equivalent Json representation. This method must be used if the specified object is a generic type. For non-generic objects, use toJson(Object) instead. If you want to write out the object to a Appendable, use toJson(Object, Type, Appendable) instead.

Parameters:

src - the object for which JSON representation is to be created

typeOfSrc - The specific genericized type of src. You can obtain this type by using the genericTypeOf(Class, Type...) method. For example, to get the type for Collection<Foo>, you should use:

                                   Type typeOfSrc = genericTypeOf(Collection.class, Foo.class);
                                   

Returns:

Json representation of src

toJson

public static void toJson(java.lang.Object src,
                          java.lang.Appendable writer)
                   throws java.io.IOException

This method serializes the specified object into its equivalent Json representation. This method should be used when the specified object is not a generic type. This method uses Object.getClass() to get the type for the specified object, but the getClass() loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, use toJson(Object, Type, Appendable) instead.

Parameters:

src - the object for which Json representation is to be created

writer - Writer to which the Json representation needs to be written

Throws:

java.io.IOException - if there was a problem writing to the writer

toJson

public static void toJson(java.lang.Object src,
                          java.lang.reflect.Type typeOfSrc,
                          java.lang.Appendable writer)
                   throws java.io.IOException

This method serializes the specified object, including those of generic types, into its equivalent Json representation. This method must be used if the specified object is a generic type. For non-generic objects, use toJson(Object, Appendable) instead.

Parameters:

src - the object for which JSON representation is to be created

typeOfSrc - The specific genericized type of src. You can obtain this type by using the genericTypeOf(Class, Type...) method. For example, to get the type for Collection<Foo>, you should use:

                                   Type typeOfSrc = genericTypeOf(Collection.class, Foo.class);
                                   

writer - Writer to which the Json representation of src needs to be written.

Throws:

java.io.IOException - if there was a problem writing to the writer

toPrettyJson

public static java.lang.String toPrettyJson(java.lang.Object src)

This method serializes the specified object into its equivalent Json representation. This method should be used when the specified object is not a generic type. This method uses Object.getClass() to get the type for the specified object, but the getClass() loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, use toJson(Object, Type) instead. If you want to write out the object to a Writer, use toPrettyJson(Object, Appendable) instead.

Parameters:

src - the object for which Json representation is to be created

Returns:

Json representation of src.

toPrettyJson

public static java.lang.String toPrettyJson(java.lang.Object src,
                                            java.lang.reflect.Type typeOfSrc)

This method serializes the specified object, including those of generic types, into its equivalent Json representation. This method must be used if the specified object is a generic type. For non-generic objects, use toPrettyJson(Object) instead. If you want to write out the object to a Appendable, use toPrettyJson(Object, Type, Appendable) instead.

Parameters:

src - the object for which JSON representation is to be created

typeOfSrc - The specific genericized type of src. You can obtain this type by using the genericTypeOf(Class, Type...) method. For example, to get the type for Collection<Foo>, you should use:

                                   Type typeOfSrc = genericTypeOf(Collection.class, Foo.class);
                                   

Returns:

Json representation of src

toPrettyJson

public static void toPrettyJson(java.lang.Object src,
                                java.lang.Appendable writer)
                         throws java.io.IOException

This method serializes the specified object into its equivalent Json representation. This method should be used when the specified object is not a generic type. This method uses Object.getClass() to get the type for the specified object, but the getClass() loses the generic type information because of the Type Erasure feature of Java. Note that this method works fine if the any of the object fields are of generic type, just the object itself should not be of a generic type. If the object is of generic type, use toPrettyJson(Object, Type, Appendable) instead.

Parameters:

src - the object for which Json representation is to be created

writer - Writer to which the Json representation needs to be written

Throws:

java.io.IOException - if there was a problem writing to the writer

toPrettyJson

public static void toPrettyJson(java.lang.Object src,
                                java.lang.reflect.Type typeOfSrc,
                                java.lang.Appendable writer)
                         throws java.io.IOException

This method serializes the specified object, including those of generic types, into its equivalent Json representation. This method must be used if the specified object is a generic type. For non-generic objects, use toPrettyJson(Object, Appendable) instead.

Parameters:

src - the object for which JSON representation is to be created

typeOfSrc - The specific genericized type of src. You can obtain this type by using the genericTypeOf(Class, Type...) method. For example, to get the type for Collection<Foo>, you should use:

                                   Type typeOfSrc = genericTypeOf(Collection.class, Foo.class);
                                   

writer - Writer to which the Json representation of src needs to be written.

Throws:

java.io.IOException - if there was a problem writing to the writer

fromJson

public static <T> T fromJson(java.lang.String json,
                             java.lang.Class<T> classOfT)
                      throws JsonSyntaxException

This method deserializes the specified Json into an object of the specified class. It is not suitable to use if the specified class is a generic type since it will not have the generic type information because of the Type Erasure feature of Java. Therefore, this method should not be used if the desired type is a generic type. Note that this method works fine if the any of the fields of the specified object are generics, just the object itself should not be a generic type. For the cases when the object is of generic type, invoke fromJson(String, Type). If you have the Json in a Reader instead of a String, use fromJson(Reader, Class) instead.

Type Parameters:

T - the type of the desired object

Parameters:

json - the string from which the object is to be deserialized

classOfT - the class of T

Returns:

an object of type T from the string.

Throws:

JsonSyntaxException - if json is not a valid representation for an object of type classOfT

fromJson

public static <T> T fromJson(java.lang.String json,
                             java.lang.reflect.Type typeOfT)
                      throws JsonSyntaxException

This method deserializes the specified Json into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, use fromJson(String, Class) instead. If you have the Json in a Reader instead of a String, use fromJson(Reader, Type) instead.

Type Parameters:

T - the type of the desired object

Parameters:

json - the string from which the object is to be deserialized

typeOfT - The specific genericized type of src. You can obtain this type by using the genericTypeOf(Class, Type...) method. For example, to get the type for Collection<Foo>, you should use:

                               Type typeOfT = genericTypeOf(Collection.class, Foo.class);
                               

Returns:

an object of type T from the string.

Throws:

JsonSyntaxException - if json is not a valid representation for an object of type

fromJson

public static <T> T fromJson(java.io.Reader json,
                             java.lang.Class<T> classOfT)
                      throws java.io.IOException,
                             JsonSyntaxException

This method deserializes the Json read from the specified reader into an object of the specified class. It is not suitable to use if the specified class is a generic type since it will not have the generic type information because of the Type Erasure feature of Java. Therefore, this method should not be used if the desired type is a generic type. Note that this method works fine if the any of the fields of the specified object are generics, just the object itself should not be a generic type. For the cases when the object is of generic type, invoke fromJson(Reader, Type). If you have the Json in a String form instead of a Reader, use fromJson(String, Class) instead.

Type Parameters:

T - the type of the desired object

Parameters:

json - the reader producing the Json from which the object is to be deserialized.

classOfT - the class of T

Returns:

an object of type T from the string.

Throws:

java.io.IOException - if there was a problem reading from the Reader

JsonSyntaxException - if json is not a valid representation for an object of type

fromJson

public static <T> T fromJson(java.io.Reader json,
                             java.lang.reflect.Type typeOfT)
                      throws java.io.IOException,
                             JsonSyntaxException

This method deserializes the Json read from the specified reader into an object of the specified type. This method is useful if the specified object is a generic type. For non-generic objects, use fromJson(Reader, Class) instead. If you have the Json in a String form instead of a Reader, use fromJson(String, Type) instead.

Type Parameters:

T - the type of the desired object

Parameters:

json - the reader producing Json from which the object is to be deserialized

typeOfT - The specific genericized type of src. You can obtain this type by using the genericTypeOf(Class, Type...) method. For example, to get the type for Collection<Foo>, you should use:

                               Type typeOfT = genericTypeOf(Collection.class, Foo.class);
                               

Returns:

an object of type T from the json.

Throws:

java.io.IOException - if there was a problem reading from the Reader

JsonSyntaxException - if json is not a valid representation for an object of type

genericTypeOf

public static java.lang.reflect.Type genericTypeOf(java.lang.Class<?> rawType,
                                                   java.lang.reflect.Type... typeArguments)

Returns a new parameterized type, applying typeArguments to rawType.

Parameters:

rawType - the raw type

typeArguments - type arguments

Returns:

a parameterized type.