net.croz.nrich.jackson.starter.properties.NrichJacksonProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nrich-jackson-spring-boot-starter Show documentation

Nrich Jackson Spring Boot starter. Additionally configures some useful defaults for Jackson

The newest version!

/*
 *  Copyright 2020-2023 CROZ d.o.o, 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
 *
 *      https://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 net.croz.nrich.jackson.starter.properties;

import lombok.Getter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.DefaultValue;

import java.util.List;

@Getter
@ConfigurationProperties("nrich.jackson")
public class NrichJacksonProperties {

    /**
     * Whether empty strings should be converted to null values.
     */
    private final boolean convertEmptyStringsToNull;

    /**
     * Whether class name should be serialized.
     */
    private final boolean serializeClassName;

    /**
     * Whether class name should be serialized for classes annotated with JPA Entity annotation.
     */
    private final boolean serializeClassNameForEntityAnnotatedClasses;

    /**
     * Package list for which class name should be also be serialized.
     */
    private final List additionalPackageListForClassNameSerialization;

    public NrichJacksonProperties(@DefaultValue("true") boolean convertEmptyStringsToNull, @DefaultValue("true") boolean serializeClassName,
                                  @DefaultValue("true") boolean serializeClassNameForEntityAnnotatedClasses, List additionalPackageListForClassNameSerialization) {
        this.convertEmptyStringsToNull = convertEmptyStringsToNull;
        this.serializeClassName = serializeClassName;
        this.serializeClassNameForEntityAnnotatedClasses = serializeClassNameForEntityAnnotatedClasses;
        this.additionalPackageListForClassNameSerialization = additionalPackageListForClassNameSerialization;
    }
}