nz.net.osnz.common.jackson.JacksonHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-jackson Show documentation

Jackson dependencies and helper utilities

There is a newer version: 2.2

package nz.net.osnz.common.jackson;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import org.springframework.stereotype.Component;

/**
 * This is a static helper utility class for quickly serialising and de-serialising JAXB-mapped structures. Uses a
 * Jackson {@link com.fasterxml.jackson.core.JsonFactory} to perform the operations.
 */
@SuppressWarnings("deprecation")
@Component
public class JacksonHelper implements JacksonHelperApi {

    private static ObjectMapper mapper;

    static {
        JsonFactory factory = new JsonFactory();

        mapper = new ObjectMapper(factory);

        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        mapper.disable(MapperFeature.AUTO_DETECT_IS_GETTERS);
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
    }

    /**
     * Serialises a provided Object to JSON.
     *
     * @param dataToSerialize The Object to serialise.
     * @return The provided Object structure as a JSON String.
     * @throws JacksonException
     */
    public static String serialize(Object dataToSerialize) throws JacksonException {
        try {
            return mapper.writeValueAsString(dataToSerialize);
        } catch (Exception e) {
            throw new JacksonException(e);
        }
    }

    /**
     * Constructs an Object from JSON String data.
     *
     * @param text The JSON String to parse.
     * @param type The Class of the Object to construct.
     * @param   The type of Object to construct.
     * @return The constructed Object if the JSON String input parses correctly.
     * @throws JacksonException
     */
    public static  T deserialize(String text, Class type) throws JacksonException {
        try {
            return mapper.reader(type).readValue(text);
        } catch (Exception e) {
            throw new JacksonException(e);
        }
    }

    @Override
    public String jsonSerialize(Object dataToSerialize) throws JacksonException {
        return serialize(dataToSerialize);
    }

    @Override
    public  T jsonDeserialize(String text, Class type) throws JacksonException {
        return deserialize(text, type);
    }

}