ratpack.jackson.JacksonModule.java Source code

Introduction

Here is the source code for ratpack.jackson.JacksonModule.java

Source

/*
 * Copyright 2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ratpack.jackson;

import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.fasterxml.jackson.core.util.MinimalPrettyPrinter;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectReader;
import com.fasterxml.jackson.databind.ObjectWriter;
import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.inject.Scopes;
import ratpack.jackson.internal.DefaultJsonRenderer;
import ratpack.jackson.internal.JsonNoOptParser;
import ratpack.jackson.internal.JsonParser;

import javax.inject.Singleton;

/**
 * A Guice module that provides an implementation of {@link JsonRenderer}, a renderer for {@link Jackson} object.
 * <p>
 * Also provides a default instance of {@link ObjectMapper}, which is the engine for serialization, and an
 * instance of {@link ObjectWriter} derived from this which is used by the {@link JsonRenderer} implementation.
 * To globally customize JSON generation, It is usually sufficient to override the {@link ObjectMapper} binding.
 */
@SuppressWarnings("UnusedDeclaration")
public class JacksonModule extends AbstractModule {

    private boolean prettyPrint = true;

    /**
     * Disables pretty printing by default whe rendering JSON.
     * <p>
     * Pretty printing is enabled by default.
     *
     * @return this.
     */
    public JacksonModule noPrettyPrint() {
        prettyPrint = false;
        return this;
    }

    @Override
    protected void configure() {
        bind(ObjectMapper.class).in(Scopes.SINGLETON);
        bind(JsonParser.class).in(Scopes.SINGLETON);
        bind(JsonNoOptParser.class).in(Scopes.SINGLETON);
        bind(JsonRenderer.class).to(DefaultJsonRenderer.class);
    }

    @Provides
    @Singleton
    protected ObjectWriter objectWriter(ObjectMapper objectMapper) {
        return objectMapper.writer(prettyPrint ? new DefaultPrettyPrinter() : new MinimalPrettyPrinter());
    }

    @Provides
    @Singleton
    protected ObjectReader objectReader(ObjectMapper objectMapper) {
        return objectMapper.reader();
    }

}