org.swat.json.utils.JsonUtilFX Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-utils Show documentation
There is a newer version: 6.0.1
/*
 * Copyright © 2017 Swatantra Agrawal. All rights reserved.
 */

package org.swat.json.utils;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.type.CollectionType;
import com.fasterxml.jackson.databind.type.MapType;
import com.fasterxml.jackson.databind.type.TypeFactory;
import org.swat.core.utils.CoreRtException;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * The Utilities for Json. In encapsulates ObjectMapper and provides additional method to deal with Json
 * It is immutable
 *
 * @author Swatantra Agrawal on 27-AUG-2017
 */
public class JsonUtilFX implements JsonUtil {
  private final ObjectMapper OBJECT_MAPPER;

  /**
   * Instantiates a new Json util.
   */
  public JsonUtilFX() {
    OBJECT_MAPPER = new ObjectMapper();
  }

  /**
   * Instantiates a new Json util.
   *
   * @param objectMapper the object mapper
   */
  public JsonUtilFX(ObjectMapper objectMapper) {
    OBJECT_MAPPER = objectMapper.copy();
  }

  /**
   * Configure json util.
   *
   * @param serializationFeature the serialization feature
   * @param state                the state
   * @return the json util
   */
  public JsonUtilFX configure(SerializationFeature serializationFeature, boolean state) {
    JsonUtilFX jsonUtil = new JsonUtilFX(OBJECT_MAPPER);
    jsonUtil.OBJECT_MAPPER.configure(serializationFeature, state);
    return jsonUtil;
  }

  /**
   * Set serialization inclusion json util.
   *
   * @param inclusion the inclusion
   * @return the json util
   */
  public JsonUtilFX setSerializationInclusion(JsonInclude.Include inclusion) {
    JsonUtilFX jsonUtil = new JsonUtilFX(OBJECT_MAPPER);
    jsonUtil.OBJECT_MAPPER.setSerializationInclusion(inclusion);
    return jsonUtil;
  }

  /**
   * Register modules json util.
   *
   * @param modules the modules
   * @return the json util
   */
  public JsonUtil registerModules(Module... modules) {
    JsonUtilFX jsonUtil = new JsonUtilFX(OBJECT_MAPPER);
    jsonUtil.OBJECT_MAPPER.registerModules(modules);
    return jsonUtil;
  }

  /**
   * Parses the json to desired type
   *
   * @param         Generics
   * @param jsonStream The input stream
   * @param clazz      The Object type
   * @return The parsed Object.
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public  T readObject(InputStream jsonStream, Class clazz) throws CoreRtException {
    try {
      return OBJECT_MAPPER.readValue(jsonStream, clazz);
    } catch (IOException e) {
      throw new CoreRtException(e);
    }
  }

  /**
   * Parses the json to List of desired type
   *
   * @param     Generics
   * @param stream The JSON stream
   * @param clazz  The Object type
   * @return The parsed List.
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public  List readList(InputStream stream, Class clazz) throws CoreRtException {
    TypeFactory typeFactory = TypeFactory.defaultInstance();
    CollectionType collectionType = typeFactory.constructCollectionType(ArrayList.class, clazz);
    try {
      return OBJECT_MAPPER.readValue(stream, collectionType);
    } catch (IOException e) {
      throw new CoreRtException(e);
    }
  }

  /**
   * Gets a copy of object mapper.
   *
   * @return the object mapper
   */
  public ObjectMapper getOBJECT_MAPPER() {
    return OBJECT_MAPPER.copy();
  }

  /**
   * Parses the json to List of desired type
   *
   * @param    Generics
   * @param json  The JSON
   * @param clazz The Object type
   * @return The parsed List.
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public  List readList(String json, Class clazz) throws CoreRtException {
    TypeFactory typeFactory = TypeFactory.defaultInstance();
    CollectionType collectionType = typeFactory.constructCollectionType(ArrayList.class, clazz);
    try {
      return OBJECT_MAPPER.readValue(json, collectionType);
    } catch (IOException e) {
      throw new CoreRtException(e);
    }
  }

  /**
   * Parses the json to Map of desired type
   *
   * @param         Generics
   * @param         Generics
   * @param json       The JSON
   * @param keyClass   The Key Type
   * @param valueClass The Value Type
   * @return The parsed Map.
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public  Map readMap(String json, Class keyClass, Class valueClass) throws CoreRtException {
    TypeFactory typeFactory = TypeFactory.defaultInstance();
    MapType mapType = typeFactory.constructMapType(HashMap.class, keyClass, valueClass);
    try {
      return OBJECT_MAPPER.readValue(json, mapType);
    } catch (IOException e) {
      throw new CoreRtException(e);
    }
  }

  /**
   * Method convert to json string for the input object
   *
   * @param object {@link Object} - The input object
   * @return {@link String} - The output json string
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public String toJsonString(Object object) throws CoreRtException {
    try {
      return OBJECT_MAPPER.writeValueAsString(object);
    } catch (JsonProcessingException e) {
      throw new CoreRtException(e);
    }
  }

  /**
   * Reads json as Object
   *
   * @param    Generics
   * @param json  The json
   * @param clazz The class of Object
   * @return The object
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public  T readObject(String json, Class clazz) throws CoreRtException {
    try {
      return OBJECT_MAPPER.readValue(json, clazz);
    } catch (IOException e) {
      throw new CoreRtException(e);
    }
  }

  /**
   * Returns prettified json of the object
   *
   * @param object The object
   * @return The prettified json
   * @throws CoreRtException in case of any Exception
   */
  @Override
  public String pretty(Object object) throws CoreRtException {
    try {
      return OBJECT_MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(object);
    } catch (JsonProcessingException e) {
      throw new CoreRtException(e);
    }
  }
}