com.udeyrishi.androidelasticsearchdatamanager.JsonFormatter.java Source code

Introduction

Here is the source code for com.udeyrishi.androidelasticsearchdatamanager.JsonFormatter.java

Source

/**
 Copyright 2016 Udey Rishi
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */

package com.udeyrishi.androidelasticsearchdatamanager;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonSerializer;
import com.udeyrishi.androidelasticsearchdatamanager.datamanagers.JsonDataManager;

import java.util.HashMap;
import java.util.Map;

/**
 * A class for specifying the JSON format the {@link JsonDataManager} should use.
 * Created by rishi on 15-10-30.
 */
public class JsonFormatter {
    private boolean useExplicitExposeAnnotation;
    private boolean usePrettyJson;
    private HashMap<Class<?>, JsonSerializer<?>> serializers = new HashMap<>();
    private HashMap<Class<?>, JsonDeserializer<?>> deserializers = new HashMap<>();

    /**
     * Creates an instance of the {@link JsonFormatter}.
     *
     * @param useExplicitExposeAnnotation True, if the @expose annotations are to be explicitly used,
     *                                    else false. If this is set to true, only the fields with
     *                                    the annotation @expose will be serialized/de-serialized.
     * @param usePrettyJson               True, if the serialized JSON needs to be in "pretty" format (with
     *                                    appropriate newlines and indentations). False, if the JSON needs to be
     *                                    in a single line.
     */
    public JsonFormatter(boolean useExplicitExposeAnnotation, boolean usePrettyJson) {
        setUseExplicitExposeAnnotation(useExplicitExposeAnnotation);
        setUsePrettyJson(usePrettyJson);
    }

    /**
     * Gets the {@link JsonFormatter}'s current "use explicit expose annotation" setting. If this is
     * set to true, only the fields with the annotation @expose will be serialized/de-serialized.
     *
     * @return The current "use explicit expose annotation" setting.
     */
    public boolean getUseExplicitExposeAnnotation() {
        return useExplicitExposeAnnotation;
    }

    /**
     * Sets the {@link JsonFormatter}'s current "use explicit expose annotation" setting. If this is
     * set to true, only the fields with the annotation @expose will be serialized/de-serialized.
     *
     * @param useExplicitExposeAnnotation The new "use explicit expose annotation" setting.
     */
    public void setUseExplicitExposeAnnotation(boolean useExplicitExposeAnnotation) {
        this.useExplicitExposeAnnotation = useExplicitExposeAnnotation;
    }

    /**
     * Gets the {@link JsonFormatter}'s current "use pretty JSON" setting.
     *
     * @return True, if the serialized JSON needs to be in "pretty" format (with appropriate
     * newlines and indentations). False, if the JSON needs to be in a single line.
     */
    public boolean getUsePrettyJson() {
        return usePrettyJson;
    }

    /**
     * Sets the {@link JsonFormatter}'s current "use pretty JSON" setting.
     *
     * @param usePrettyJson True, if the serialized JSON needs to be in "pretty" format (with appropriate
     *                      newlines and indentations). False, if the JSON needs to be in a single line.
     */
    public void setUsePrettyJson(boolean usePrettyJson) {
        this.usePrettyJson = usePrettyJson;
    }

    /**
     * Gets the {@link Gson} object configured with the settings of this {@link JsonFormatter}.
     *
     * @return The properly configured {@link Gson}.
     */
    public Gson getGson() {
        GsonBuilder gsonBuilder = new GsonBuilder();

        if (getUsePrettyJson()) {
            gsonBuilder.setPrettyPrinting();
        }

        if (getUseExplicitExposeAnnotation()) {
            gsonBuilder.excludeFieldsWithoutExposeAnnotation();
        }

        // Register custom serializers
        for (Map.Entry<Class<?>, JsonSerializer<?>> entry : serializers.entrySet()) {
            gsonBuilder.registerTypeHierarchyAdapter(entry.getKey(), entry.getValue());
        }

        for (Map.Entry<Class<?>, JsonDeserializer<?>> entry : deserializers.entrySet()) {
            gsonBuilder.registerTypeHierarchyAdapter(entry.getKey(), entry.getValue());
        }

        return gsonBuilder.create();
    }

    /**
     * Registers a type hierarchy serialization adapter to be used when constructing the {@link Gson}
     * object via {@link JsonFormatter#getGson()} method.
     *
     * @param classOfObject The {@link Class} of the object to be serialized.
     * @param serializer    The custom {@link JsonSerializer} to be used for this type.
     */
    public void registerSerializer(Class<?> classOfObject, JsonSerializer<?> serializer) {
        serializers.put(classOfObject, serializer);
    }

    /**
     * Registers a type hierarchy deserialization adapter to be used when constructing the {@link Gson}
     * object via {@link JsonFormatter#getGson()} method.
     *
     * @param classOfObject The {@link Class} of the object to be serialized.
     * @param deserializer    The custom {@link JsonSerializer} to be used for this type.
     */
    public void registerDeserializer(Class<?> classOfObject, JsonDeserializer<?> deserializer) {
        deserializers.put(classOfObject, deserializer);
    }
}