org.springframework.boot.convert

Class ApplicationConversionService

java.lang.Object

org.springframework.core.convert.support.GenericConversionService

org.springframework.format.support.FormattingConversionService

org.springframework.boot.convert.ApplicationConversionService

All Implemented Interfaces:

Aware, EmbeddedValueResolverAware, ConversionService, ConverterRegistry, ConfigurableConversionService, FormatterRegistry

public class ApplicationConversionService
extends FormattingConversionService

A specialization of FormattingConversionService configured by default with converters and formatters appropriate for most Spring Boot applications.

Designed for direct instantiation but also exposes the static addApplicationConverters(org.springframework.core.convert.converter.ConverterRegistry) and addApplicationFormatters(FormatterRegistry) utility methods for ad-hoc use against registry instance.

Since:

2.0.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor and Description
ApplicationConversionService()
ApplicationConversionService(StringValueResolver embeddedValueResolver)

Method Summary

Modifier and Type	Method and Description
static void	addApplicationConverters(ConverterRegistry registry) Add converters useful for most Spring Boot applications.
static void	addApplicationFormatters(FormatterRegistry registry) Add formatters useful for most Spring Boot applications.
static void	addBeans(FormatterRegistry registry, ListableBeanFactory beanFactory) Add GenericConverter, Converter, Printer, Parser and Formatter beans from the specified context.
static void	addDelimitedStringConverters(ConverterRegistry registry) Add converters to support delimited strings.
static void	configure(FormatterRegistry registry) Configure the given FormatterRegistry with formatters and converters appropriate for most Spring Boot applications.
static ConversionService	getSharedInstance() Return a shared default application ConversionService instance, lazily building it once needed.
boolean	isConvertViaObjectSourceType(TypeDescriptor sourceType, TypeDescriptor targetType) Return true if objects of sourceType can be converted to the targetType and the converter has Object.class as a supported source type.

Methods inherited from class org.springframework.format.support.FormattingConversionService

addFormatter, addFormatterForFieldAnnotation, addFormatterForFieldType, addFormatterForFieldType, addParser, addPrinter, setEmbeddedValueResolver

Methods inherited from class org.springframework.core.convert.support.GenericConversionService

addConverter, addConverter, addConverter, addConverterFactory, canBypassConvert, canConvert, canConvert, convert, convert, convert, convertNullSource, getConverter, getDefaultConverter, removeConvertible, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.convert.converter.ConverterRegistry

addConverter, addConverter, addConverter, addConverterFactory, removeConvertible

Constructor Detail

ApplicationConversionService

public ApplicationConversionService()

ApplicationConversionService

public ApplicationConversionService(StringValueResolver embeddedValueResolver)

Method Detail

isConvertViaObjectSourceType

public boolean isConvertViaObjectSourceType(TypeDescriptor sourceType,
                                            TypeDescriptor targetType)

Return true if objects of sourceType can be converted to the targetType and the converter has Object.class as a supported source type.

Parameters:

sourceType - the source type to test

targetType - the target type to test

Returns:

if conversion happens via an ObjectTo... converter

Since:

2.4.3

getSharedInstance

public static ConversionService getSharedInstance()

Return a shared default application ConversionService instance, lazily building it once needed.

Note: This method actually returns an ApplicationConversionService instance. However, the ConversionService signature has been preserved for binary compatibility.

Returns:

the shared ApplicationConversionService instance (never null)

configure

public static void configure(FormatterRegistry registry)

Configure the given FormatterRegistry with formatters and converters appropriate for most Spring Boot applications.

Parameters:

registry - the registry of converters to add to (must also be castable to ConversionService, e.g. being a ConfigurableConversionService)

Throws:

ClassCastException - if the given FormatterRegistry could not be cast to a ConversionService

addApplicationConverters

public static void addApplicationConverters(ConverterRegistry registry)

Add converters useful for most Spring Boot applications.

Parameters:

registry - the registry of converters to add to (must also be castable to ConversionService, e.g. being a ConfigurableConversionService)

Throws:

ClassCastException - if the given ConverterRegistry could not be cast to a ConversionService

addDelimitedStringConverters

public static void addDelimitedStringConverters(ConverterRegistry registry)

Add converters to support delimited strings.

Parameters:

registry - the registry of converters to add to (must also be castable to ConversionService, e.g. being a ConfigurableConversionService)

Throws:

ClassCastException - if the given ConverterRegistry could not be cast to a ConversionService

addApplicationFormatters

public static void addApplicationFormatters(FormatterRegistry registry)

Add formatters useful for most Spring Boot applications.

Parameters:

registry - the service to register default formatters with

addBeans

public static void addBeans(FormatterRegistry registry,
                            ListableBeanFactory beanFactory)

Add GenericConverter, Converter, Printer, Parser and Formatter beans from the specified context.

Parameters:

registry - the service to register beans with

beanFactory - the bean factory to get the beans from

Since:

2.2.0