Spring Framework 6.1.4 · org.springframework.format.support.FormattingConversionServiceFactoryBean

A factory providing convenient access to a FormattingConversionService configured with converters and formatters for common types such as numbers and datetimes.

Additional converters and formatters can be registered declaratively through setConverters(Set) and setFormatters(Set). Another option is to register converters and formatters in code by implementing the FormatterRegistrar interface. You can then configure provide the set of registrars to use through setFormatterRegistrars(Set).

A good example for registering converters and formatters in code is JodaTimeFormatterRegistrar, which registers a number of date-related formatters and converters. For a more detailed list of cases see setFormatterRegistrars(Set)

Like all FactoryBean implementations, this class is suitable for use when configuring a Spring application context using Spring <beans> XML. When configuring the container with @Configuration classes, simply instantiate, configure and return the appropriate FormattingConversionService object from a @Bean method.

Field Summary

Modifier and Type	Field and Description
private FormattingConversionService	conversionService
private Set<?>	converters
private StringValueResolver	embeddedValueResolver
private Set<FormatterRegistrar>	formatterRegistrars
private Set<?>	formatters
private boolean	registerDefaultFormatters

Constructor Summary

Access	Constructor and Description
public	FormattingConversionServiceFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
public FormattingConversionService	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<? extends FormattingConversionService>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
private void	registerFormatters(FormattingConversionService conversionService)
public void	setConverters(Set<?> instances of any of the following: `org.springframework.core.convert.converter.Converter`, `org.springframework.core.convert.converter.ConverterFactory`, `org.springframework.core.convert.converter.GenericConverter` converters) Configure the set of custom converter objects that should be added.
public void	setEmbeddedValueResolver(StringValueResolver embeddedValueResolver) Implements org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver. Set the StringValueResolver to use for resolving embedded definition values.
public void	setFormatterRegistrars(Set<FormatterRegistrar> formatterRegistrars) Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively via `setConverters(Set)` and `setFormatters(Set)`.
public void	setFormatters(Set<?> instances of `Formatter` or `AnnotationFormatterFactory` formatters) Configure the set of custom formatter objects that should be added.
public void	setRegisterDefaultFormatters(boolean registerDefaultFormatters) Indicate whether default formatters should be registered or not.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

conversionService	back to summary
private FormattingConversionService conversionService Annotations @Nullable

converters	back to summary
private Set<?> converters Annotations @Nullable

embeddedValueResolver	back to summary
private StringValueResolver embeddedValueResolver Annotations @Nullable

formatterRegistrars	back to summary
private Set<FormatterRegistrar> formatterRegistrars Annotations @Nullable

formatters	back to summary
private Set<?> formatters Annotations @Nullable

registerDefaultFormatters	back to summary
private boolean registerDefaultFormatters

Constructor Detail

FormattingConversionServiceFactoryBean	back to summary
public FormattingConversionServiceFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

getObject back to summary

getObject	back to summary
public FormattingConversionService getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern. If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:FormattingConversionService an instance of the bean (can be `null`) Annotations @Override @Nullable

public FormattingConversionService getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:FormattingConversionService

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<? extends FormattingConversionService> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance. This allows one to check for specific types of beans without instantiating objects, for example on autowiring. In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too. This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available. Note Autowiring will simply ignore FactoryBeans that return `null` here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean. Returns:Class<? extends FormattingConversionService> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<? extends FormattingConversionService> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

Note

Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Returns:Class<? extends FormattingConversionService>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference. The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there. Note This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean#isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`. The default implementation returns `true`, since a `FactoryBean` typically manages a singleton instance. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Note

This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean#isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

The default implementation returns true, since a FactoryBean typically manages a singleton instance.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

registerFormatters	back to summary
private void registerFormatters(FormattingConversionService conversionService)

setConverters back to summary

setConverters	back to summary
public void setConverters(Set<?> converters) Configure the set of custom converter objects that should be added. Parameters converters:Set<?> instances of any of the following: `org.springframework.core.convert.converter.Converter`, `org.springframework.core.convert.converter.ConverterFactory`, `org.springframework.core.convert.converter.GenericConverter`

public void setConverters(Set<?> converters)

Configure the set of custom converter objects that should be added.

Parameters

converters:Set<?>: instances of any of the following: org.springframework.core.convert.converter.Converter, org.springframework.core.convert.converter.ConverterFactory, org.springframework.core.convert.converter.GenericConverter

setEmbeddedValueResolver	back to summary
public void setEmbeddedValueResolver(StringValueResolver embeddedValueResolver) Implements org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver. Doc from org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver. Set the StringValueResolver to use for resolving embedded definition values. Annotations @Override

setEmbeddedValueResolver

back to summary

public void setEmbeddedValueResolver(StringValueResolver embeddedValueResolver)

Implements org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver.

Doc from org.springframework.context.EmbeddedValueResolverAware.setEmbeddedValueResolver.

Set the StringValueResolver to use for resolving embedded definition values.

Annotations

@Override

setFormatterRegistrars back to summary

setFormatterRegistrars	back to summary
public void setFormatterRegistrars(Set<FormatterRegistrar> formatterRegistrars) Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively via `setConverters(Set)` and `setFormatters(Set)`. FormatterRegistrars are useful when registering multiple related converters and formatters for a formatting category, such as Date formatting. All types related needed to support the formatting category can be registered from one place. FormatterRegistrars can also be used to register Formatters indexed under a specific field type different from its own <T>, or when registering a Formatter from a Printer/Parser pair. See Also `FormatterRegistry#addFormatterForFieldType(Class, Formatter)`, `FormatterRegistry#addFormatterForFieldType(Class, Printer, Parser)`

public void setFormatterRegistrars(Set<FormatterRegistrar> formatterRegistrars)

Configure the set of FormatterRegistrars to invoke to register Converters and Formatters in addition to those added declaratively via setConverters(Set) and setFormatters(Set).

FormatterRegistrars are useful when registering multiple related converters and formatters for a formatting category, such as Date formatting. All types related needed to support the formatting category can be registered from one place.

FormatterRegistrars can also be used to register Formatters indexed under a specific field type different from its own <T>, or when registering a Formatter from a Printer/Parser pair.

See Also: FormatterRegistry#addFormatterForFieldType(Class, Formatter), FormatterRegistry#addFormatterForFieldType(Class, Printer, Parser)

setFormatters back to summary

setFormatters	back to summary
public void setFormatters(Set<?> formatters) Configure the set of custom formatter objects that should be added. Parameters formatters:Set<?> instances of `Formatter` or `AnnotationFormatterFactory`

public void setFormatters(Set<?> formatters)

Configure the set of custom formatter objects that should be added.

Parameters

formatters:Set<?>: instances of Formatter or AnnotationFormatterFactory

setRegisterDefaultFormatters back to summary

setRegisterDefaultFormatters	back to summary
public void setRegisterDefaultFormatters(boolean registerDefaultFormatters) Indicate whether default formatters should be registered or not. By default, built-in formatters are registered. This flag can be used to turn that off and rely on explicitly registered formatters only. See Also `setFormatters(Set)`, `setFormatterRegistrars(Set)`

public void setRegisterDefaultFormatters(boolean registerDefaultFormatters)

Indicate whether default formatters should be registered or not.

By default, built-in formatters are registered. This flag can be used to turn that off and rely on explicitly registered formatters only.

See Also: setFormatters(Set), setFormatterRegistrars(Set)

public Class FormattingConversionServiceFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail