io.victoralbertos.jolyglot

Interface Jolyglot

All Known Subinterfaces:

JolyglotGenerics

public interface Jolyglot

A layer of abstraction for common data binding operations built upon next popular json libraries: Gson, Jackson and Moshi. This interface is not suitable to use if the specified class is a generic type. For the cases when the object is of generic type, use JolyglotGenerics

Method Summary

Modifier and Type	Method and Description
<T> T	fromJson(java.io.File file, java.lang.Class<T> classOfT) This method deserializes the Json read from the specified reader into an object of the specified class.
<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.
java.lang.String	toJson(java.lang.Object src) This method serializes the specified object into its equivalent Json representation.

Method Detail

toJson

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.

Parameters:

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

Returns:

Json representation of src.

fromJson

<T> T fromJson(java.lang.String json,
               java.lang.Class<T> classOfT)
        throws java.lang.RuntimeException

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 JolyglotGenerics.fromJson(String, Type). If you have the Json in a File instead of a String, use fromJson(File, 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:

java.lang.RuntimeException

fromJson

<T> T fromJson(java.io.File file,
               java.lang.Class<T> classOfT)
        throws java.lang.RuntimeException

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 JolyglotGenerics.fromJson(File, Type). If you have the Json in a String form instead of a File, use fromJson(String, Class) instead.

Type Parameters:

T - the type of the desired object

Parameters:

file - the file 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.lang.RuntimeException