Class JacksonYamlHttpMessageConverter

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<Object>

org.springframework.http.converter.AbstractSmartHttpMessageConverter<Object>

org.springframework.http.converter.AbstractJacksonHttpMessageConverter<tools.jackson.dataformat.yaml.YAMLMapper>

org.springframework.http.converter.yaml.JacksonYamlHttpMessageConverter

All Implemented Interfaces:

HttpMessageConverter<Object>, SmartHttpMessageConverter<Object>

public class JacksonYamlHttpMessageConverter
extends AbstractJacksonHttpMessageConverter<tools.jackson.dataformat.yaml.YAMLMapper>

Implementation of HttpMessageConverter that can read and write the YAML data format using the dedicated Jackson 3.x extension.

By default, this converter supports the MediaType.APPLICATION_YAML_VALUE media type. This can be overridden by setting the supportedMediaTypes property.

The following hints entries are supported:

• A JSON view with a "com.fasterxml.jackson.annotation.JsonView" key and the class name of the JSON view as value.
• A filter provider with a "tools.jackson.databind.ser.FilterProvider" key and the filter provider class name as value.

Since:

7.0

Author:

Sebastien Deleuze

Field Summary

Fields inherited from class AbstractJacksonHttpMessageConverter

defaultMapper

Fields inherited from class AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor	Description
JacksonYamlHttpMessageConverter()	Construct a new instance with a YAMLMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).
JacksonYamlHttpMessageConverter(tools.jackson.dataformat.yaml.YAMLMapper mapper)	Construct a new instance with the provided YAMLMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).
JacksonYamlHttpMessageConverter(tools.jackson.dataformat.yaml.YAMLMapper.Builder builder)	Construct a new instance with the provided YAMLMapper.

Method Summary

Methods inherited from class AbstractJacksonHttpMessageConverter

canRead, canWrite, customizeReader, customizeWriter, getCharset, getJavaType, getJsonEncoding, getMapper, getMappersForType, getMediaTypesForProblemDetail, getSupportedMediaTypes, read, readInternal, registerMappersForType, setSupportedMediaTypes, supportsRepeatableWrites, writeInternal, writePrefix, writeSuffix

Methods inherited from class AbstractSmartHttpMessageConverter

canWrite, supports, write, writeInternal

Methods inherited from class AbstractHttpMessageConverter

addDefaultHeaders, canRead, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, write

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface HttpMessageConverter

getSupportedMediaTypes

Methods inherited from interface SmartHttpMessageConverter

canRead, read, write

Constructor Details

JacksonYamlHttpMessageConverter

public JacksonYamlHttpMessageConverter()

Construct a new instance with a YAMLMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).

JacksonYamlHttpMessageConverter

public JacksonYamlHttpMessageConverter(tools.jackson.dataformat.yaml.YAMLMapper.Builder builder)

Construct a new instance with the provided YAMLMapper.

See Also:

• YAMLMapper.builder()

JacksonYamlHttpMessageConverter

public JacksonYamlHttpMessageConverter(tools.jackson.dataformat.yaml.YAMLMapper mapper)

Construct a new instance with the provided YAMLMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).

See Also:

• YAMLMapper.builder()