craterdog.smart.SmartObjectMapper.java Source code

Introduction

Here is the source code for craterdog.smart.SmartObjectMapper.java

Source

/************************************************************************
 * Copyright (c) Crater Dog Technologies(TM).  All Rights Reserved.     *
 ************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.        *
 *                                                                      *
 * This code is free software; you can redistribute it and/or modify it *
 * under the terms of The MIT License (MIT), as published by the Open   *
 * Source Initiative. (See http://opensource.org/licenses/MIT)          *
 ************************************************************************/
package craterdog.smart;

import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.PrettyPrinter;
import com.fasterxml.jackson.core.util.DefaultIndenter;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.joda.JodaModule;

/**
 * This object mapper handles the conversion of a smart object to and from a JSON string. The mapper
 * can be configured to censor sensitive attributes that are marked with the <code>@Sensitive</code>
 * annotation.
 *
 * @author Jeff Webb
 * @author Mukesh Jyothi
 * @author Derk Norton
 */
@SuppressWarnings("serial")
public class SmartObjectMapper extends ObjectMapper {

    /**
     * This constructor creates a new smart object mapper for the specified modules.
     *
     * @param modules The modules to be registered.
     */
    public SmartObjectMapper(Module... modules) {
        super();

        // indent the output
        enable(SerializationFeature.INDENT_OUTPUT);

        // allow empty beans
        disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);

        // don't serialize nulls
        disable(SerializationFeature.WRITE_NULL_MAP_VALUES);
        setSerializationInclusion(Include.NON_NULL);

        // don't fail on unknown properties
        configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

        // write dates out as string (not milliseconds since epoch <- timestamp)
        disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);

        // handle joda types
        registerModule(new JodaModule());

        // add any additional modules passed in
        for (Module module : modules) {
            registerModule(module);
        }

    }

    @Override
    public String writeValueAsString(Object value) throws JsonProcessingException {
        return writer(_defaultPrettyPrinter()).writeValueAsString(value);
    }

    /**
     * This method behaves similarly to the <code>writeValueAsString(Object value)</code> method
     * except that it includes an indentation prefix that will be prepended to each line of the
     * resulting string (except the first line).
     *
     * @param value The smart object to be written out as a string.
     * @param indentation The indentation string to be prepended to each line.
     * @return The formatted string.
     * @throws JsonProcessingException
     */
    public String writeValueAsString(Object value, String indentation) throws JsonProcessingException {
        return writer(_defaultPrettyPrinter(indentation)).writeValueAsString(value);
    }

    /**
     * This method overrides the same method in the super class and returns a better
     * pretty printer implementation.  NOTE: This looks like it would set the default
     * pretty printer for all uses by the object mapper but it does NOT.  I think this
     * is a case of the original intent changing or being lost over time.  There is an
     * enhancement request to address this problem, for more details see:
     * https://github.com/FasterXML/jackson-databind/issues/689.
     *
     * @return The better pretty printer to be used to format the JSON output.
     */
    @Override
    protected PrettyPrinter _defaultPrettyPrinter() {
        return new BetterPrettyPrinter().withArrayIndenter(new DefaultIndenter());
    }

    /**
     * This method behaves similarly to the <code>_defaultPrettyPrinter()</code> method
     * except that it includes an indentation prefix that will be prepended to each line of the
     * resulting string (except the first line).
     *
     * @param indentation The indentation string to be prepended to each line.
     * @return The better pretty printer to be used to format the JSON output.
     */
    protected PrettyPrinter _defaultPrettyPrinter(String indentation) {
        return new BetterPrettyPrinter(indentation).withArrayIndenter(new DefaultIndenter());
    }

    private class BetterPrettyPrinter extends DefaultPrettyPrinter {

        BetterPrettyPrinter() {
            super();
        }

        BetterPrettyPrinter(String indentation) {
            super();
            _nesting = indentation.length() / 2; // two spaces per level
        }

    }

}