/Jolyglot

Agnostic Json abstraction to perform data binding operations for Android and Java.

Primary LanguageJavaApache License 2.0Apache-2.0

Android Arsenal

Jolyglot

Jolyglot allows to convert objects to and from Json without depending on any concrete implementation. Thus, you can happy code against this polyglot abstraction, and let the clients of your library choose whatever json provider which better suits their needs.

Available json providers

Available json providers supporting generics

Setup

Add JitPack repository in your build.gradle (top level module):

allprojects {
    repositories {
        jcenter()
        maven { url 'https://jitpack.io' }
    }
}

And add Jolyglot api module in the build.gradle of your library module:

dependencies {
    compile 'com.github.VictorAlbertos.Jolyglot:api:0.0.6'
}

Ask to the clients of your library to add one of the next json providers:

dependencies {
    implementation 'com.github.VictorAlbertos.Jolyglot:gson:0.0.6'
    implementation 'com.github.VictorAlbertos.Jolyglot:jackson:0.0.6'
    implementation 'com.github.VictorAlbertos.Jolyglot:moshi:0.0.6'
    implementation 'com.github.VictorAlbertos.Jolyglot:fastjson:0.0.6'
}

Usage

Instantiate Jolyglot.

Ask to the client of your library for an implementation of Jolyglot if your library doesn't need to deal with generics. Otherwise, ask for an instance of JolyglotGenerics.

Depending on the provider chosen by your client, the instance of Jolyglot will be created in one of the next ways:

Jolyglot jolyglot = new GsonSpeaker()
Jolyglot jolyglot = new GsonSpeaker(gson) //overloaded constructor to customize the gson object.

Jolyglot jolyglot = new JacksonSpeaker()
Jolyglot jolyglot = new JacksonSpeaker(objectMapper) //overloaded constructor to customize the objectMapper object.

Jolyglot jolyglot = new MoshiSpeaker()
Jolyglot jolyglot = new MoshiSpeaker(moshi) //overloaded constructor to customize the moshi object.

Jolyglot jolyglot = new FastJsonSpeaker()

Object to json.

jolyglot.toJson(object);

Json to object.

String json = "";
jolyglot.fromJson(json, Your.class);

Generic object to json.

Type type = jolyglot.newParameterizedType(YourParameterized.class, YourEnclosing.class);
jolyglot.toJson(parameterizedObject, type);

Json to generic object.

String json = "";
Type type = jolyglot.newParameterizedType(YourParameterized.class, YourEnclosing.class);
jolyglot.fromJson(json, type);

For a complete example go here.

Be aware that the idiosyncrasy of every underlying json provider still remains. Jolyglot is only an abstraction layer to honor this diversity, but, in the end, every java class serialized/deserialized needs to fulfill the requirements of every json provider.