org.spincast.plugins.jacksonjson.SpincastJsonManagerConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spincast-plugins-jackson-json Show documentation

The default Spincast Jackson Json plugin

The newest version!

package org.spincast.plugins.jacksonjson;

import com.google.inject.ImplementedBy;

/**
 * Configurations for the Spincast Json Manager plugin.
 * 
 * We use "@ImplementedBy" to specify the default configurations
 * to use if none is specified in a Guice module.
 */
@ImplementedBy(SpincastJsonManagerConfigDefault.class)
public interface SpincastJsonManagerConfig {

    /**
     * The number of space to use as indentation for pretty print.
     * Defaults to 4.
     */
    public int getPrettyPrinterIndentationSpaceNumber();

    /**
     * The newline characters to use for pretty print.
     * Defaults to "\n".
     */
    public String getPrettyPrinterNewlineChars();

    /**
     * Should enums be serialized to :
     * 
     * {
     *     "name" : "ENUM_ELEMENT_NAME",
     *     "label" : "result of ENUM_ELEMENT_NAME.toString()"
     * }
     * 
     * 
     * If false, an enum is serialized to its name
     * only.
     */
    public boolean isSerializeEnumsToNameAndLabelObjects();

}