org.springframework.boot.autoconfigure.jackson.JacksonProperties Maven / Gradle / Ivy
/*
* Copyright 2012-2021 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 org.springframework.boot.autoconfigure.jackson;
import java.util.EnumMap;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.SerializationFeature;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Configuration properties to configure Jackson.
*
* @author Andy Wilkinson
* @author Marcel Overdijk
* @author Johannes Edmeier
* @since 1.2.0
*/
@ConfigurationProperties(prefix = "spring.jackson")
public class JacksonProperties {
/**
* Date format string or a fully-qualified date format class name. For instance,
* 'yyyy-MM-dd HH:mm:ss'.
*/
private String dateFormat;
/**
* One of the constants on Jackson's PropertyNamingStrategies. Can also be a
* fully-qualified class name of a PropertyNamingStrategy implementation.
*/
private String propertyNamingStrategy;
/**
* Jackson visibility thresholds that can be used to limit which methods (and fields)
* are auto-detected.
*/
private final Map visibility = new EnumMap<>(PropertyAccessor.class);
/**
* Jackson on/off features that affect the way Java objects are serialized.
*/
private final Map serialization = new EnumMap<>(SerializationFeature.class);
/**
* Jackson on/off features that affect the way Java objects are deserialized.
*/
private final Map deserialization = new EnumMap<>(DeserializationFeature.class);
/**
* Jackson general purpose on/off features.
*/
private final Map mapper = new EnumMap<>(MapperFeature.class);
/**
* Jackson on/off features for parsers.
*/
private final Map parser = new EnumMap<>(JsonParser.Feature.class);
/**
* Jackson on/off features for generators.
*/
private final Map generator = new EnumMap<>(JsonGenerator.Feature.class);
/**
* Controls the inclusion of properties during serialization. Configured with one of
* the values in Jackson's JsonInclude.Include enumeration.
*/
private JsonInclude.Include defaultPropertyInclusion;
/**
* Time zone used when formatting dates. For instance, "America/Los_Angeles" or
* "GMT+10".
*/
private TimeZone timeZone = null;
/**
* Locale used for formatting.
*/
private Locale locale;
public String getDateFormat() {
return this.dateFormat;
}
public void setDateFormat(String dateFormat) {
this.dateFormat = dateFormat;
}
public String getPropertyNamingStrategy() {
return this.propertyNamingStrategy;
}
public void setPropertyNamingStrategy(String propertyNamingStrategy) {
this.propertyNamingStrategy = propertyNamingStrategy;
}
public Map getVisibility() {
return this.visibility;
}
public Map getSerialization() {
return this.serialization;
}
public Map getDeserialization() {
return this.deserialization;
}
public Map getMapper() {
return this.mapper;
}
public Map getParser() {
return this.parser;
}
public Map getGenerator() {
return this.generator;
}
public JsonInclude.Include getDefaultPropertyInclusion() {
return this.defaultPropertyInclusion;
}
public void setDefaultPropertyInclusion(JsonInclude.Include defaultPropertyInclusion) {
this.defaultPropertyInclusion = defaultPropertyInclusion;
}
public TimeZone getTimeZone() {
return this.timeZone;
}
public void setTimeZone(TimeZone timeZone) {
this.timeZone = timeZone;
}
public Locale getLocale() {
return this.locale;
}
public void setLocale(Locale locale) {
this.locale = locale;
}
}