springfox.documentation.schema.property.ObjectMapperBeanPropertyNamingStrategy.java Source code

Introduction

Here is the source code for springfox.documentation.schema.property.ObjectMapperBeanPropertyNamingStrategy.java

Source

/*
 *
 *  Copyright 2015 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 springfox.documentation.schema.property;

import com.fasterxml.jackson.databind.DeserializationConfig;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategy;
import com.fasterxml.jackson.databind.SerializationConfig;
import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
import com.google.common.base.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
import springfox.documentation.schema.configuration.ObjectMapperConfigured;

/**
 * BeanPropertyNamingStrategy based on ObjectMapper naming strategy.
 * Uses {@link com.fasterxml.jackson.databind.PropertyNamingStrategy} to name.
 * In case it cannot get information from property's getter or field, it returns the same current name.
 */
@Component
public class ObjectMapperBeanPropertyNamingStrategy
        implements BeanPropertyNamingStrategy, ApplicationListener<ObjectMapperConfigured> {

    private static final Logger LOG = LoggerFactory.getLogger(ObjectMapperBeanPropertyNamingStrategy.class);
    private ObjectMapper objectMapper;

    public ObjectMapperBeanPropertyNamingStrategy() {
    }

    @Override
    public String nameForSerialization(final BeanPropertyDefinition beanProperty) {

        SerializationConfig serializationConfig = objectMapper.getSerializationConfig();

        Optional<PropertyNamingStrategy> namingStrategy = Optional
                .fromNullable(serializationConfig.getPropertyNamingStrategy());
        String newName = namingStrategy
                .transform(BeanPropertyDefinitions.overTheWireName(beanProperty, serializationConfig))
                .or(beanProperty.getName());

        LOG.debug("Name '{}' renamed to '{}'", beanProperty.getName(), newName);

        return newName;
    }

    @Override
    public String nameForDeserialization(final BeanPropertyDefinition beanProperty) {

        DeserializationConfig deserializationConfig = objectMapper.getDeserializationConfig();

        Optional<PropertyNamingStrategy> namingStrategy = Optional
                .fromNullable(deserializationConfig.getPropertyNamingStrategy());
        String newName = namingStrategy
                .transform(BeanPropertyDefinitions.overTheWireName(beanProperty, deserializationConfig))
                .or(beanProperty.getName());

        LOG.debug("Name '{}' renamed to '{}'", beanProperty.getName(), newName);

        return newName;
    }

    @Override
    public void onApplicationEvent(ObjectMapperConfigured event) {
        this.objectMapper = event.getObjectMapper();
    }
}