io.citrine.jpif.util.PifObjectMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpif Show documentation

This package includes java objects for all items in the Physical Information File (PIF), http://www.citrine.io/pif. Files formatted in the PIF schema can be serialized and deserialized using included methods.

There is a newer version: 2.7.2

Show newest version

package io.citrine.jpif.util;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import io.citrine.jpif.obj.system.System;

import java.io.IOException;
import java.util.List;

/**
 * Class used to serialize and deserialize from the PIF schema.
 *
 * @author Kyle Michel
 */
public class PifObjectMapper extends ObjectMapper {

    /**
     * Get a static instance of this class.
     *
     * @return {@link PifObjectMapper} object.
     */
    public static PifObjectMapper getInstance() {
        return Holder.PIF_OBJECT_MAPPER;
    }

    /**
     * Get a writer for writing lists of systems.
     *
     * @return {@link ObjectWriter} for a list of {@link System} objects.
     */
    public ObjectWriter getSystemListWriter() {
        return this.writerWithType(Holder.SYSTEM_LIST_TYPE);
    }

    /**
     * Create a deep copy of the input object using the settings in this object mapper.
     *
     * @param objectToCopy Object to make a deep copy of.
     * @param objectClass Class of objectToCopy.
     * @return A new instance of objectClass type which is a deep copy of objectToCopy.
     * @throws IOException if the input object cannot be copied.
     */
    public static  U deepCopy(final T objectToCopy, final Class objectClass) throws IOException {
        return Holder.PIF_OBJECT_MAPPER.readValue(
                Holder.PIF_OBJECT_MAPPER.writeValueAsBytes(objectToCopy),
                objectClass);
    }

    /**
     * Constructor. This configures the object mapper underlying this class.
     */
    private PifObjectMapper() {
        this.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
        this.configure(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY, true);
        this.configure(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT, true);
        this.configure(DeserializationFeature.UNWRAP_SINGLE_VALUE_ARRAYS, true);
        this.configure(JsonParser.Feature.ALLOW_NON_NUMERIC_NUMBERS, true);
    }

    /**
     * Holder class.
     *
     * @author Kyle Michel
     */
    private static class Holder {

        /** Instance of the PIF object mapper to use. */
        private static final PifObjectMapper PIF_OBJECT_MAPPER = new PifObjectMapper();

        /** Type for a list of systems. */
        private static final TypeReference> SYSTEM_LIST_TYPE = new TypeReference>() {};
    }
}