Class HttpMessageConverters
java.lang.Object
org.springframework.boot.autoconfigure.http.HttpMessageConverters
- All Implemented Interfaces:
Iterable<HttpMessageConverter<?>>
Bean used to manage the
HttpMessageConverter
s used in a Spring Boot
application. Provides a convenient way to add and merge additional
HttpMessageConverter
s 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
) with some slight re-ordering to put XML converters
at the back of the list.
- Since:
- 2.0.0
- Author:
- Dave Syer, Phillip Webb, Andy Wilkinson
- See Also:
-
Constructor Summary
ConstructorDescriptionHttpMessageConverters
(boolean addDefaultConverters, Collection<HttpMessageConverter<?>> converters) Create a newHttpMessageConverters
instance with the specified converters.HttpMessageConverters
(Collection<HttpMessageConverter<?>> additionalConverters) Create a newHttpMessageConverters
instance with the specified additional converters.HttpMessageConverters
(HttpMessageConverter<?>... additionalConverters) Create a newHttpMessageConverters
instance with the specified additional converters. -
Method Summary
Modifier and TypeMethodDescriptionReturn an immutable list of the converters in the order that they will be registered.iterator()
protected List<HttpMessageConverter<?>>
postProcessConverters
(List<HttpMessageConverter<?>> converters) Method that can be used to post-process theHttpMessageConverter
list before it is used.protected List<HttpMessageConverter<?>>
postProcessPartConverters
(List<HttpMessageConverter<?>> converters) Method that can be used to post-process theHttpMessageConverter
list before it is used to configure the part converters ofAllEncompassingFormHttpMessageConverter
.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 Details
-
HttpMessageConverters
Create a newHttpMessageConverters
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). ThepostProcessConverters(List)
method can be used for further converter manipulation.
-
HttpMessageConverters
Create a newHttpMessageConverters
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). ThepostProcessConverters(List)
method can be used for further converter manipulation.
-
HttpMessageConverters
public HttpMessageConverters(boolean addDefaultConverters, Collection<HttpMessageConverter<?>> converters) Create a newHttpMessageConverters
instance with the specified converters.- Parameters:
addDefaultConverters
- if default converters should be addedconverters
- 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). ThepostProcessConverters(List)
method can be used for further converter manipulation.
-
-
Method Details
-
postProcessConverters
protected List<HttpMessageConverter<?>> postProcessConverters(List<HttpMessageConverter<?>> converters) Method that can be used to post-process theHttpMessageConverter
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 theHttpMessageConverter
list before it is used to configure the part converters ofAllEncompassingFormHttpMessageConverter
.- Parameters:
converters
- a mutable list of the converters that will be used.- Returns:
- the final converts list to use
- Since:
- 1.3.0
-
iterator
- Specified by:
iterator
in interfaceIterable<HttpMessageConverter<?>>
-
getConverters
Return an immutable list of the converters in the order that they will be registered.- Returns:
- the converters
-