org.springframework.boot.autoconfigure.http

Class HttpMessageConverters

java.lang.Object

org.springframework.boot.autoconfigure.http.HttpMessageConverters

All Implemented Interfaces:

Iterable<HttpMessageConverter<?>>

public class HttpMessageConverters
extends Object
implements Iterable<HttpMessageConverter<?>>

Bean used to manage the HttpMessageConverters used in a Spring Boot application. Provides a convenient way to add and merge additional HttpMessageConverters to a web application.

An instance of this bean can be registered with specific additional converters if needed, otherwise default converters will be used.

NOTE: The default converters used are the same as standard Spring MVC (see WebMvcConfigurationSupport.getMessageConverters() with some slight re-ordering to put XML converters at the back of the list.

Author:

Dave Syer, Phillip Webb, Andy Wilkinson

See Also:

HttpMessageConverters(HttpMessageConverter...), HttpMessageConverters(Collection), getConverters()

Constructor Summary

Constructors

Constructor and Description
HttpMessageConverters(boolean addDefaultConverters, Collection<HttpMessageConverter<?>> converters) Create a new HttpMessageConverters instance with the specified converters.
HttpMessageConverters(Collection<HttpMessageConverter<?>> additionalConverters) Create a new HttpMessageConverters instance with the specified additional converters.
HttpMessageConverters(HttpMessageConverter<?>... additionalConverters) Create a new HttpMessageConverters instance with the specified additional converters.

Method Summary

Modifier and Type	Method and Description
List<HttpMessageConverter<?>>	getConverters() Return an immutable list of the converters in the order that they will be registered.
Iterator<HttpMessageConverter<?>>	iterator()
protected List<HttpMessageConverter<?>>	postProcessConverters(List<HttpMessageConverter<?>> converters) Method that can be used to post-process the HttpMessageConverter list before it is used.
protected List<HttpMessageConverter<?>>	postProcessPartConverters(List<HttpMessageConverter<?>> converters) Method that can be used to post-process the HttpMessageConverter list before it is used to configure the part converters of AllEncompassingFormHttpMessageConverter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

HttpMessageConverters

public HttpMessageConverters(HttpMessageConverter<?>... additionalConverters)

Create a new HttpMessageConverters instance with the specified additional converters.

Parameters:

additionalConverters - additional converters to be added. New converters will be added to the front of the list, overrides will replace existing items without changing the order. The getConverters() methods can be used for further converter manipulation.

HttpMessageConverters

public HttpMessageConverters(Collection<HttpMessageConverter<?>> additionalConverters)

Create a new HttpMessageConverters instance with the specified additional converters.

Parameters:

additionalConverters - additional converters to be added. Items are added just before any default converter of the same type (or at the front of the list if no default converter is found) The postProcessConverters(List) method can be used for further converter manipulation.

HttpMessageConverters

public HttpMessageConverters(boolean addDefaultConverters,
                             Collection<HttpMessageConverter<?>> converters)

Create a new HttpMessageConverters instance with the specified converters.

Parameters:

addDefaultConverters - if default converters should be added

converters - converters to be added. Items are added just before any default converter of the same type (or at the front of the list if no default converter is found) The postProcessConverters(List) method can be used for further converter manipulation.

Method Detail

postProcessConverters

protected List<HttpMessageConverter<?>> postProcessConverters(List<HttpMessageConverter<?>> converters)

Method that can be used to post-process the HttpMessageConverter list before it is used.

Parameters:

converters - a mutable list of the converters that will be used.

Returns:

the final converts list to use

postProcessPartConverters

protected List<HttpMessageConverter<?>> postProcessPartConverters(List<HttpMessageConverter<?>> converters)

Method that can be used to post-process the HttpMessageConverter list before it is used to configure the part converters of AllEncompassingFormHttpMessageConverter.

Parameters:

converters - a mutable list of the converters that will be used.

Returns:

the final converts list to use

Since:

1.3.0

iterator

public Iterator<HttpMessageConverter<?>> iterator()

Specified by:

iterator in interface Iterable<HttpMessageConverter<?>>

getConverters

public List<HttpMessageConverter<?>> getConverters()

Return an immutable list of the converters in the order that they will be registered.

Returns:

the converters