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(ConverterRegistry) and addApplicationFormatters(FormatterRegistry) utility methods for ad-hoc use against registry instance.

Since:

2.0.0

Author:

Phillip Webb, Shixiong Guo

Constructor Summary

Constructors

Constructor	Description
ApplicationConversionService()
ApplicationConversionService(@Nullable StringValueResolver embeddedValueResolver)

Method Summary

Modifier and Type	Method	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 Printer, Parser, Formatter, Converter, ConverterFactory, GenericConverter, and beans from the specified bean factory.
static Map<String,Object>	addBeans(FormatterRegistry registry, ListableBeanFactory beanFactory, @Nullable String qualifier)	Add Printer, Parser, Formatter, Converter, ConverterFactory, GenericConverter, and beans from the specified bean factory.
<S,T> void	addConverter(Class<S> sourceType, Class<T> targetType, Converter<? super S, ? extends T> converter)
void	addConverter(Converter<?,?> converter)
void	addConverter(GenericConverter converter)
void	addConverterFactory(ConverterFactory<?,?> factory)
static void	addDelimitedStringConverters(ConverterRegistry registry)	Add converters to support delimited strings.
void	addFormatter(Formatter<?> formatter)
void	addFormatterForFieldAnnotation(AnnotationFormatterFactory<? extends Annotation> annotationFormatterFactory)
void	addFormatterForFieldType(Class<?> fieldType, Formatter<?> formatter)
void	addFormatterForFieldType(Class<?> fieldType, Printer<?> printer, Parser<?> parser)
void	addParser(Parser<?> parser)
void	addPrinter(Printer<?> printer)
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.
void	removeConvertible(Class<?> sourceType, Class<?> targetType)

Methods inherited from class FormattingConversionService

setEmbeddedValueResolver

Methods inherited from class GenericConversionService

canBypassConvert, canConvert, canConvert, convert, convert, convertNullSource, getConverter, getDefaultConverter, toString

Methods inherited from class Object

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

Methods inherited from interface ConversionService

convert

Constructor Details

ApplicationConversionService

public ApplicationConversionService()

ApplicationConversionService

public ApplicationConversionService(@Nullable StringValueResolver embeddedValueResolver)

Method Details

addPrinter

public void addPrinter(Printer<?> printer)

Specified by:

addPrinter in interface FormatterRegistry

Overrides:

addPrinter in class FormattingConversionService

addParser

public void addParser(Parser<?> parser)

Specified by:

addParser in interface FormatterRegistry

Overrides:

addParser in class FormattingConversionService

addFormatter

public void addFormatter(Formatter<?> formatter)

Specified by:

addFormatter in interface FormatterRegistry

Overrides:

addFormatter in class FormattingConversionService

addFormatterForFieldType

public void addFormatterForFieldType(Class<?> fieldType,
 Formatter<?> formatter)

Specified by:

addFormatterForFieldType in interface FormatterRegistry

Overrides:

addFormatterForFieldType in class FormattingConversionService

addConverter

public void addConverter(Converter<?,?> converter)

Specified by:

addConverter in interface ConverterRegistry

Overrides:

addConverter in class GenericConversionService

addFormatterForFieldType

public void addFormatterForFieldType(Class<?> fieldType,
 Printer<?> printer,
 Parser<?> parser)

Specified by:

addFormatterForFieldType in interface FormatterRegistry

Overrides:

addFormatterForFieldType in class FormattingConversionService

addFormatterForFieldAnnotation

public void addFormatterForFieldAnnotation(AnnotationFormatterFactory<? extends Annotation> annotationFormatterFactory)

Specified by:

addFormatterForFieldAnnotation in interface FormatterRegistry

Overrides:

addFormatterForFieldAnnotation in class FormattingConversionService

addConverter

public <S,T> void addConverter(Class<S> sourceType,
 Class<T> targetType,
 Converter<? super S, ? extends T> converter)

Specified by:

addConverter in interface ConverterRegistry

Overrides:

addConverter in class GenericConversionService

addConverter

public void addConverter(GenericConverter converter)

Specified by:

addConverter in interface ConverterRegistry

Overrides:

addConverter in class GenericConversionService

addConverterFactory

public void addConverterFactory(ConverterFactory<?,?> factory)

Specified by:

addConverterFactory in interface ConverterRegistry

Overrides:

addConverterFactory in class GenericConversionService

removeConvertible

public void removeConvertible(Class<?> sourceType,
 Class<?> targetType)

Specified by:

removeConvertible in interface ConverterRegistry

Overrides:

removeConvertible in class GenericConversionService

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 through 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 Printer, Parser, Formatter, Converter, ConverterFactory, GenericConverter, and beans from the specified bean factory.

Parameters:

registry - the service to register beans with

beanFactory - the bean factory to get the beans from

Since:

2.2.0

addBeans

public static Map<String,Object> addBeans(FormatterRegistry registry,
 ListableBeanFactory beanFactory,
 @Nullable String qualifier)

Add Printer, Parser, Formatter, Converter, ConverterFactory, GenericConverter, and beans from the specified bean factory.

Parameters:

registry - the service to register beans with

beanFactory - the bean factory to get the beans from

qualifier - the qualifier required on the beans or null

Returns:

the beans that were added

Since:

3.5.0