org.mlflow.utils.SerializationUtils Maven / Gradle / Ivy

package org.mlflow.utils;

import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import java.io.File;
import java.io.IOException;

/**
 * Utilities for serializing and deserializing objects to and from various persistence formats, such
 * as JSON and YAML
 */
public class SerializationUtils {
  private static final ObjectMapper jsonMapper = new ObjectMapper(new JsonFactory());
  private static final ObjectMapper yamlMapper = new ObjectMapper(new YAMLFactory());

  /**
   * Produces a JSON string representation of a Java object
   *
   * @return A string in valid JSON format
   */
  public static String toJson(Object object) throws JsonProcessingException {
    return jsonMapper.writeValueAsString(object);
  }

  /**
   * Produces a Java object representation of a JSON-formatted string
   *
   * @param json A string in valid JSON format
   * @param objectClass The class of the Java object that should be produced
   */
  public static  T fromJson(String json, Class objectClass) throws IOException {
    return jsonMapper.readValue(json, objectClass);
  }

  /**
   * Produces a Java object representation of a JSON-formatted file
   *
   * @param filePath The path to the JSON-formatted file
   * @param objectClass The class of the Java object that should be produced
   */
  public static  T parseJsonFromFile(String filePath, Class objectClass) throws IOException {
    File jsonFile = new File(filePath);
    return parseJsonFromFile(jsonFile, objectClass);
  }

  /**
   * Produces a Java object representation of a JSON-formatted file
   *
   * @param jsonFile A reference to a JSON-formatted file
   * @param objectClass The class of the Java object that should be produced
   */
  public static  T parseJsonFromFile(File jsonFile, Class objectClass) throws IOException {
    return parseFromFile(jsonFile, objectClass, jsonMapper);
  }

  /**
   * Produces a Java object representation of a YAML-formatted file
   *
   * @param filePath The path to the YAML-formatted file
   * @param objectClass The class of the Java object that should be produced
   */
  public static  T parseYamlFromFile(String filePath, Class objectClass) throws IOException {
    File yamlFile = new File(filePath);
    return parseYamlFromFile(yamlFile, objectClass);
  }

  /**
   * Produces a Java object representation of a YAML-formatted file
   *
   * @param yamlFile A reference to a JSON-formatted file
   * @param objectClass The class of the Java object that should be produced
   */
  public static  T parseYamlFromFile(File yamlFile, Class objectClass) throws IOException {
    return parseFromFile(yamlFile, objectClass, yamlMapper);
  }

  private static  T parseFromFile(File file, Class objectClass, ObjectMapper mapper)
      throws IOException {
    return mapper.readValue(file, objectClass);
  }
}